From 41a906d886b7f86ef7a9c764bbcb9441eeade416 Mon Sep 17 00:00:00 2001 From: Sai Venkat Desu Date: Wed, 19 Jun 2024 19:57:48 +0530 Subject: [PATCH] Release 2.8.0 --- Auth0.podspec | 2 +- Auth0/Info.plist | 2 +- Auth0/Version.swift | 2 +- CHANGELOG.md | 6 +++ Gemfile.lock | 41 ++++++++++-------- README.md | 4 +- docs/data/documentation/auth0.json | 2 +- .../documentation/auth0/auth0apierror.json | 2 +- .../auth0/auth0apierror/code.json | 2 +- .../auth0/auth0apierror/info.json | 2 +- .../auth0apierror/init(info:statuscode:).json | 2 +- .../auth0/auth0apierror/statuscode.json | 2 +- docs/data/documentation/auth0/auth0error.json | 2 +- .../auth0/auth0error/cause-1atql.json | 2 +- .../auth0/auth0error/cause-9wuyi.json | 2 +- .../auth0/auth0error/errordescription.json | 2 +- .../auth0error/localizeddescription.json | 2 +- ...hentication(clientid:domain:session:).json | 2 +- .../authentication(session:bundle:).json | 2 +- .../documentation/auth0/authentication.json | 2 +- .../auth0/authentication/clientid.json | 2 +- ...e(withcode:codeverifier:redirecturi:).json | 2 +- .../auth0/authentication/jwks().json | 2 +- ...llname:profile:audience:scope:)-6sf9m.json | 2 +- ...llname:profile:audience:scope:)-7k4xo.json | 2 +- ...gin(email:code:audience:scope:)-39g8b.json | 2 +- ...gin(email:code:audience:scope:)-587bo.json | 2 +- ...stoken:profile:audience:scope:)-28ncj.json | 2 +- ...stoken:profile:audience:scope:)-8wh5g.json | 2 +- ...onenumber:code:audience:scope:)-38nv0.json | 2 +- ...onenumber:code:audience:scope:)-8kbii.json | 2 +- ...lmorconnection:audience:scope:)-5yc0w.json | 2 +- ...lmorconnection:audience:scope:)-8kdlq.json | 2 +- ...hoobcode:mfatoken:bindingcode:)-3r1t9.json | 2 +- ...hoobcode:mfatoken:bindingcode:)-3ykhg.json | 2 +- .../login(withotp:mfatoken:).json | 2 +- .../login(withrecoverycode:mfatoken:).json | 2 +- ...rname:password:audience:scope:)-3uzbn.json | 2 +- ...rname:password:audience:scope:)-4gru8.json | 2 +- ...fatoken:types:authenticatorid:)-3p692.json | 2 +- ...fatoken:types:authenticatorid:)-7xrct.json | 2 +- .../renew(withrefreshtoken:scope:)-2llyg.json | 2 +- .../renew(withrefreshtoken:scope:)-8vkbb.json | 2 +- .../resetpassword(email:connection:).json | 2 +- .../authentication/revoke(refreshtoken:).json | 2 +- ...n:usermetadata:rootattributes:)-4rw4y.json | 2 +- ...n:usermetadata:rootattributes:)-92l3l.json | 2 +- ...ordless(email:type:connection:)-56xbe.json | 2 +- ...ordless(email:type:connection:)-6xl8p.json | 2 +- ...s(phonenumber:type:connection:)-5azmm.json | 2 +- ...ss(phonenumber:type:connection:)-9unt.json | 2 +- .../auth0/authentication/url.json | 2 +- .../userinfo(withaccesstoken:).json | 2 +- .../auth0/authenticationerror.json | 2 +- .../auth0/authenticationerror/!=(_:_:).json | 2 +- .../auth0/authenticationerror/==(_:_:).json | 2 +- .../auth0error-implementations.json | 2 +- .../auth0/authenticationerror/cause.json | 2 +- .../auth0/authenticationerror/code.json | 2 +- .../authenticationerror/debugdescription.json | 2 +- .../equatable-implementations.json | 2 +- .../authenticationerror/errordescription.json | 2 +- .../authenticationerror/failurereason.json | 2 +- .../auth0/authenticationerror/helpanchor.json | 2 +- .../auth0/authenticationerror/info.json | 2 +- .../init(info:statuscode:).json | 2 +- .../authenticationerror/isaccessdenied.json | 2 +- .../isinvalidcredentials.json | 2 +- .../isinvalidrefreshtoken.json | 2 +- .../authenticationerror/isloginrequired.json | 2 +- .../ismultifactorcodeinvalid.json | 2 +- .../ismultifactorenrollrequired.json | 2 +- .../ismultifactorrequired.json | 2 +- .../ismultifactortokeninvalid.json | 2 +- .../authenticationerror/isnetworkerror.json | 2 +- .../ispasswordalreadyused.json | 2 +- .../authenticationerror/ispasswordleaked.json | 2 +- .../ispasswordnotstrongenough.json | 2 +- .../isrefreshtokendeleted.json | 2 +- .../authenticationerror/isruleerror.json | 2 +- .../istoomanyattempts.json | 2 +- .../isverificationrequired.json | 2 +- .../localizeddescription.json | 2 +- .../localizederror-implementations.json | 2 +- .../recoverysuggestion.json | 2 +- .../auth0/authenticationerror/statuscode.json | 2 +- .../auth0/authenticationresult.json | 2 +- docs/data/documentation/auth0/challenge.json | 2 +- .../auth0/challenge/bindingmethod.json | 2 +- .../auth0/challenge/challengetype.json | 2 +- .../auth0/challenge/init(from:).json | 2 +- .../auth0/challenge/oobcode.json | 2 +- .../data/documentation/auth0/credentials.json | 2 +- .../auth0/credentials/accesstoken.json | 2 +- .../decodable-implementations.json | 2 +- .../auth0/credentials/description.json | 2 +- .../auth0/credentials/encode(with:).json | 2 +- .../auth0/credentials/expiresin.json | 2 +- .../auth0/credentials/idtoken.json | 2 +- ...htoken:expiresin:scope:recoverycode:).json | 2 +- .../auth0/credentials/init(coder:).json | 2 +- .../auth0/credentials/init(from:).json | 2 +- .../credentials/nscoding-implementations.json | 2 +- .../nssecurecoding-implementations.json | 2 +- .../auth0/credentials/recoverycode.json | 2 +- .../auth0/credentials/refreshtoken.json | 2 +- .../auth0/credentials/scope.json | 2 +- .../credentials/supportssecurecoding.json | 2 +- .../auth0/credentials/tokentype.json | 2 +- .../auth0/credentialsmanager.json | 2 +- .../auth0/credentialsmanager/canrenew().json | 2 +- .../auth0/credentialsmanager/clear().json | 2 +- ...ope:minttl:parameters:headers:)-11d2f.json | 2 +- ...ope:minttl:parameters:headers:)-7xldm.json | 2 +- ...:minttl:parameters:headers:callback:).json | 2 +- ...itle:fallbacktitle:evaluationpolicy:).json | 2 +- .../credentialsmanager/hasvalid(minttl:).json | 2 +- ...nit(authentication:storekey:storage:).json | 2 +- .../renew(parameters:headers:)-3jl3m.json | 2 +- .../renew(parameters:headers:)-7yn20.json | 2 +- .../renew(parameters:headers:callback:).json | 2 +- .../revoke(headers:)-6wgai.json | 2 +- .../revoke(headers:)-9mzo6.json | 2 +- .../revoke(headers:_:).json | 2 +- .../store(credentials:).json | 2 +- .../auth0/credentialsmanager/user.json | 2 +- .../auth0/credentialsmanagererror.json | 2 +- .../credentialsmanagererror/!=(_:_:).json | 2 +- .../credentialsmanagererror/==(_:_:).json | 2 +- .../auth0error-implementations.json | 2 +- .../biometricsfailed.json | 2 +- .../auth0/credentialsmanagererror/cause.json | 2 +- .../debugdescription.json | 2 +- .../equatable-implementations.json | 2 +- .../errordescription.json | 2 +- .../failurereason.json | 2 +- .../credentialsmanagererror/helpanchor.json | 2 +- .../credentialsmanagererror/largeminttl.json | 2 +- .../localizeddescription.json | 2 +- .../localizederror-implementations.json | 2 +- .../nocredentials.json | 2 +- .../norefreshtoken.json | 2 +- .../recoverysuggestion.json | 2 +- .../credentialsmanagererror/renewfailed.json | 2 +- .../credentialsmanagererror/revokefailed.json | 2 +- .../credentialsmanagererror/storefailed.json | 2 +- .../~=(_:_:)-7k0od.json | 2 +- .../~=(_:_:)-93ixe.json | 2 +- .../auth0/credentialsmanagerresult.json | 2 +- .../auth0/credentialsstorage.json | 2 +- .../deleteentry(forkey:).json | 2 +- .../credentialsstorage/getentry(forkey:).json | 2 +- .../setentry(_:forkey:).json | 2 +- .../documentation/auth0/databaseuser.json | 2 +- .../documentation/auth0/defaultscope.json | 2 +- docs/data/documentation/auth0/foundation.json | 2 +- .../documentation/auth0/foundation/data.json | 2 +- .../data/a0_encodebase64urlsafe().json | 2 +- docs/data/documentation/auth0/jwk.json | 2 +- .../documentation/auth0/jwk/algorithm.json | 2 +- .../documentation/auth0/jwk/certchain.json | 2 +- .../auth0/jwk/certthumbprint.json | 2 +- .../data/documentation/auth0/jwk/certurl.json | 2 +- .../documentation/auth0/jwk/exponent.json | 2 +- .../documentation/auth0/jwk/init(from:).json | 2 +- docs/data/documentation/auth0/jwk/keyid.json | 2 +- .../data/documentation/auth0/jwk/keytype.json | 2 +- .../data/documentation/auth0/jwk/modulus.json | 2 +- docs/data/documentation/auth0/jwk/usage.json | 2 +- docs/data/documentation/auth0/jwks.json | 2 +- .../documentation/auth0/jwks/init(from:).json | 2 +- .../documentation/auth0/jwks/key(id:).json | 2 +- docs/data/documentation/auth0/jwks/keys.json | 2 +- docs/data/documentation/auth0/loggable.json | 2 +- .../documentation/auth0/loggable/logger.json | 2 +- .../auth0/loggable/logging(enabled:).json | 2 +- .../auth0/loggable/using(logger:).json | 2 +- docs/data/documentation/auth0/logger.json | 2 +- .../auth0/logger/trace(request:session:).json | 2 +- .../auth0/logger/trace(response:data:).json | 2 +- .../auth0/logger/trace(url:source:).json | 2 +- .../documentation/auth0/managementerror.json | 2 +- .../auth0/managementerror/!=(_:_:).json | 2 +- .../auth0/managementerror/==(_:_:).json | 2 +- .../auth0error-implementations.json | 2 +- .../auth0/managementerror/cause.json | 2 +- .../auth0/managementerror/code.json | 2 +- .../managementerror/debugdescription.json | 2 +- .../equatable-implementations.json | 2 +- .../managementerror/errordescription.json | 2 +- .../auth0/managementerror/failurereason.json | 2 +- .../auth0/managementerror/helpanchor.json | 2 +- .../auth0/managementerror/info.json | 2 +- .../init(info:statuscode:).json | 2 +- .../managementerror/localizeddescription.json | 2 +- .../localizederror-implementations.json | 2 +- .../managementerror/recoverysuggestion.json | 2 +- .../auth0/managementerror/statuscode.json | 2 +- .../documentation/auth0/managementobject.json | 2 +- .../documentation/auth0/managementresult.json | 2 +- .../documentation/auth0/passwordlesstype.json | 2 +- .../auth0/passwordlesstype/!=(_:_:).json | 2 +- .../auth0/passwordlesstype/androidlink.json | 2 +- .../auth0/passwordlesstype/code.json | 2 +- .../equatable-implementations.json | 2 +- .../auth0/passwordlesstype/hash(into:).json | 2 +- .../auth0/passwordlesstype/hashvalue.json | 2 +- .../passwordlesstype/init(rawvalue:).json | 2 +- .../auth0/passwordlesstype/ioslink.json | 2 +- .../rawrepresentable-implementations.json | 2 +- .../auth0/passwordlesstype/weblink.json | 2 +- .../documentation/auth0/refreshtokens.json | 2 +- docs/data/documentation/auth0/request.json | 2 +- .../documentation/auth0/request/callback.json | 2 +- .../auth0/request/headers(_:).json | 2 +- .../auth0/request/parameters(_:).json | 2 +- .../auth0/request/start()-132e1.json | 2 +- .../auth0/request/start()-8gjgk.json | 2 +- .../auth0/request/start(_:).json | 2 +- .../documentation/auth0/simplekeychain.json | 2 +- .../auth0/simplekeychain/simplekeychain.json | 2 +- .../credentialsstorage-implementations.json | 2 +- .../simplekeychain/deleteentry(forkey:).json | 2 +- .../simplekeychain/getentry(forkey:).json | 2 +- .../simplekeychain/setentry(_:forkey:).json | 2 +- docs/data/documentation/auth0/swift.json | 2 +- .../documentation/auth0/swift/string.json | 2 +- .../string/a0_decodebase64urlsafe().json | 2 +- docs/data/documentation/auth0/telemetry.json | 2 +- .../documentation/auth0/telemetry/init().json | 2 +- docs/data/documentation/auth0/trackable.json | 2 +- .../auth0/trackable/telemetry.json | 2 +- .../auth0/trackable/tracking(enabled:).json | 2 +- .../trackable/using(inlibrary:version:).json | 2 +- docs/data/documentation/auth0/useragents.json | 2 +- docs/data/documentation/auth0/userinfo.json | 2 +- .../documentation/auth0/userinfo/address.json | 2 +- .../auth0/userinfo/birthdate.json | 2 +- .../auth0/userinfo/customclaims.json | 2 +- .../documentation/auth0/userinfo/email.json | 2 +- .../auth0/userinfo/emailverified.json | 2 +- .../auth0/userinfo/familyname.json | 2 +- .../documentation/auth0/userinfo/gender.json | 2 +- .../auth0/userinfo/givenname.json | 2 +- .../auth0/userinfo/init(json:).json | 2 +- .../jsonobjectpayload-implementations.json | 2 +- .../documentation/auth0/userinfo/locale.json | 2 +- .../auth0/userinfo/middlename.json | 2 +- .../documentation/auth0/userinfo/name.json | 2 +- .../auth0/userinfo/nickname.json | 2 +- .../auth0/userinfo/phonenumber.json | 2 +- .../auth0/userinfo/phonenumberverified.json | 2 +- .../documentation/auth0/userinfo/picture.json | 2 +- .../auth0/userinfo/preferredusername.json | 2 +- .../documentation/auth0/userinfo/profile.json | 2 +- .../auth0/userinfo/publicclaims.json | 2 +- .../documentation/auth0/userinfo/sub.json | 2 +- .../auth0/userinfo/updatedat.json | 2 +- .../documentation/auth0/userinfo/website.json | 2 +- .../auth0/userinfo/zoneinfo.json | 2 +- .../auth0/userpatchattributes.json | 2 +- .../userpatchattributes/appmetadata(_:).json | 2 +- .../userpatchattributes/blocked(_:).json | 2 +- ...verified:verify:connection:clientid:).json | 2 +- .../emailverified(_:connection:).json | 2 +- .../init(dictionary:).json | 2 +- .../password(_:verify:connection:).json | 2 +- ...verified:verify:connection:clientid:).json | 2 +- .../phoneverified(_:connection:).json | 2 +- .../userpatchattributes/usermetadata(_:).json | 2 +- .../username(_:connection:).json | 2 +- .../auth0/users(token:domain:session:).json | 2 +- .../auth0/users(token:session:bundle:).json | 2 +- docs/data/documentation/auth0/users.json | 2 +- .../users/get(_:fields:include:)-7aaln.json | 2 +- .../users/get(_:fields:include:)-8mfww.json | 2 +- .../users/link(_:withotherusertoken:).json | 2 +- ...ithuser:provider:connectionid:)-5y4yy.json | 2 +- ...ithuser:provider:connectionid:)-6nwr7.json | 2 +- .../auth0/users/patch(_:attributes:).json | 2 +- .../auth0/users/patch(_:usermetadata:).json | 2 +- .../data/documentation/auth0/users/token.json | 2 +- ...link(identityid:provider:fromuserid:).json | 2 +- docs/data/documentation/auth0/users/url.json | 2 +- .../webauth(clientid:domain:session:).json | 2 +- .../auth0/webauth(session:bundle:).json | 2 +- docs/data/documentation/auth0/webauth.json | 2 +- .../auth0/webauth/audience(_:).json | 2 +- .../auth0/webauth/authorizeurl(_:).json | 1 + .../clearsession(federated:)-3k5r3.json | 2 +- .../clearsession(federated:)-4zqyr.json | 2 +- .../clearsession(federated:)-6n4z6.json | 2 +- .../clearsession(federated:)-8sl1o.json | 2 +- ...earsession(federated:callback:)-9xcu3.json | 2 +- ...earsession(federated:callback:)-9yv61.json | 2 +- .../documentation/auth0/webauth/clientid.json | 2 +- .../auth0/webauth/connection(_:).json | 2 +- .../auth0/webauth/connectionscope(_:).json | 2 +- .../auth0/webauth/invitationurl(_:).json | 2 +- .../auth0/webauth/issuer(_:).json | 2 +- .../auth0/webauth/leeway(_:).json | 2 +- .../auth0/webauth/maxage(_:).json | 2 +- .../auth0/webauth/nonce(_:).json | 2 +- .../auth0/webauth/onclose(_:).json | 2 +- .../auth0/webauth/organization(_:).json | 2 +- .../auth0/webauth/parameters(_:).json | 2 +- .../auth0/webauth/provider(_:).json | 2 +- .../auth0/webauth/redirecturl(_:).json | 2 +- .../auth0/webauth/scope(_:).json | 2 +- .../auth0/webauth/start()-98znq.json | 2 +- .../auth0/webauth/start()-qpqo.json | 2 +- .../auth0/webauth/start(_:).json | 2 +- .../auth0/webauth/state(_:).json | 2 +- .../auth0/webauth/telemetry.json | 2 +- .../data/documentation/auth0/webauth/url.json | 2 +- .../auth0/webauth/useephemeralsession().json | 2 +- .../auth0/webauth/usehttps().json | 2 +- .../auth0/webauthentication.json | 2 +- .../auth0/webauthentication/cancel().json | 2 +- .../webauthentication/resume(with:).json | 2 +- .../safariprovider(style:).json | 2 +- .../documentation/auth0/webautherror.json | 2 +- .../auth0/webautherror/!=(_:_:).json | 2 +- .../auth0/webautherror/==(_:_:).json | 2 +- .../auth0error-implementations.json | 2 +- .../auth0/webautherror/cause.json | 2 +- .../auth0/webautherror/debugdescription.json | 2 +- .../equatable-implementations.json | 2 +- .../auth0/webautherror/errordescription.json | 2 +- .../auth0/webautherror/failurereason.json | 2 +- .../auth0/webautherror/helpanchor.json | 2 +- .../webautherror/idtokenvalidationfailed.json | 2 +- .../webautherror/invalidinvitationurl.json | 2 +- .../webautherror/localizeddescription.json | 2 +- .../localizederror-implementations.json | 2 +- .../webautherror/noauthorizationcode.json | 2 +- .../webautherror/nobundleidentifier.json | 2 +- .../auth0/webautherror/other.json | 2 +- .../auth0/webautherror/pkcenotallowed.json | 2 +- .../webautherror/recoverysuggestion.json | 2 +- .../transactionactivealready.json | 1 + .../auth0/webautherror/unknown.json | 2 +- .../auth0/webautherror/usercancelled.json | 2 +- .../auth0/webautherror/~=(_:_:)-3690.json | 2 +- .../auth0/webautherror/~=(_:_:)-6ibkd.json | 2 +- .../documentation/auth0/webauthprovider.json | 2 +- .../auth0/webauthprovidercallback.json | 2 +- .../documentation/auth0/webauthresult.json | 2 +- .../documentation/auth0/webauthuseragent.json | 2 +- .../auth0/webauthuseragent/finish(with:).json | 2 +- .../auth0/webauthuseragent/start().json | 2 +- .../auth0/webauth/authorizeurl(_:)/index.html | 1 + .../transactionactivealready/index.html | 1 + docs/index/availability.index | Bin 742 -> 742 bytes docs/index/data.mdb | Bin 262144 -> 262144 bytes docs/index/index.json | 2 +- docs/index/navigator.index | Bin 61939 -> 62205 bytes docs/metadata.json | 2 +- 358 files changed, 382 insertions(+), 369 deletions(-) create mode 100644 docs/data/documentation/auth0/webauth/authorizeurl(_:).json create mode 100644 docs/data/documentation/auth0/webautherror/transactionactivealready.json create mode 100644 docs/documentation/auth0/webauth/authorizeurl(_:)/index.html create mode 100644 docs/documentation/auth0/webautherror/transactionactivealready/index.html diff --git a/Auth0.podspec b/Auth0.podspec index e52589af..06753b58 100644 --- a/Auth0.podspec +++ b/Auth0.podspec @@ -30,7 +30,7 @@ excluded_files = [*web_auth_files, *ios_files, *macos_files] Pod::Spec.new do |s| s.name = 'Auth0' - s.version = '2.7.2' + s.version = '2.8.0' s.summary = "Auth0 SDK for Apple platforms" s.description = <<-DESC Auth0 SDK for iOS, macOS, tvOS, and watchOS apps. diff --git a/Auth0/Info.plist b/Auth0/Info.plist index d800a6dd..df785569 100644 --- a/Auth0/Info.plist +++ b/Auth0/Info.plist @@ -15,7 +15,7 @@ CFBundlePackageType FMWK CFBundleShortVersionString - 2.7.2 + 2.8.0 CFBundleSignature ???? CFBundleVersion diff --git a/Auth0/Version.swift b/Auth0/Version.swift index e42732a1..5220c359 100644 --- a/Auth0/Version.swift +++ b/Auth0/Version.swift @@ -1 +1 @@ -let version = "2.7.2" +let version = "2.8.0" diff --git a/CHANGELOG.md b/CHANGELOG.md index ce33a98a..c3b1da1b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [2.8.0](https://github.com/auth0/Auth0.swift/tree/2.8.0) (2024-06-19) +[Full Changelog](https://github.com/auth0/Auth0.swift/compare/2.7.2...2.8.0) + +**Added** +- Add support for an authorize URL override [\#854](https://github.com/auth0/Auth0.swift/pull/854) ([erichoracek](https://github.com/erichoracek)) + ## [2.7.2](https://github.com/auth0/Auth0.swift/tree/2.7.2) (2024-05-08) [Full Changelog](https://github.com/auth0/Auth0.swift/compare/2.7.1...2.7.2) diff --git a/Gemfile.lock b/Gemfile.lock index 187cb854..f1747a49 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -5,7 +5,7 @@ GEM base64 nkf rexml - activesupport (7.1.3.2) + activesupport (7.1.3.4) base64 bigdecimal concurrent-ruby (~> 1.0, >= 1.0.2) @@ -23,17 +23,17 @@ GEM artifactory (3.0.17) atomos (0.1.3) aws-eventstream (1.3.0) - aws-partitions (1.925.0) - aws-sdk-core (3.194.2) + aws-partitions (1.944.0) + aws-sdk-core (3.197.0) aws-eventstream (~> 1, >= 1.3.0) aws-partitions (~> 1, >= 1.651.0) aws-sigv4 (~> 1.8) jmespath (~> 1, >= 1.6.1) - aws-sdk-kms (1.80.0) - aws-sdk-core (~> 3, >= 3.193.0) + aws-sdk-kms (1.85.0) + aws-sdk-core (~> 3, >= 3.197.0) aws-sigv4 (~> 1.1) - aws-sdk-s3 (1.149.1) - aws-sdk-core (~> 3, >= 3.194.0) + aws-sdk-s3 (1.152.3) + aws-sdk-core (~> 3, >= 3.197.0) aws-sdk-kms (~> 1) aws-sigv4 (~> 1.8) aws-sigv4 (1.8.0) @@ -84,7 +84,7 @@ GEM colored2 (3.1.2) commander (4.6.0) highline (~> 2.0.0) - concurrent-ruby (1.2.3) + concurrent-ruby (1.3.3) connection_pool (2.4.1) declarative (0.0.20) digest-crc (0.6.5) @@ -126,7 +126,7 @@ GEM faraday_middleware (1.2.0) faraday (~> 1.0) fastimage (2.3.1) - fastlane (2.220.0) + fastlane (2.221.0) CFPropertyList (>= 2.3, < 4.0.0) addressable (>= 2.8, < 3.0.0) artifactory (~> 3.0) @@ -169,7 +169,8 @@ GEM xcpretty-travis-formatter (>= 0.0.3, < 2.0.0) fastlane-plugin-auth0_shipper (0.4.1) semantic (~> 1.5) - ffi (1.16.3) + ffi (1.17.0-arm64-darwin) + ffi (1.17.0-x86_64-darwin) fourflusher (2.3.1) fuzzy_match (2.0.4) gh_inspector (1.1.3) @@ -210,18 +211,18 @@ GEM os (>= 0.9, < 2.0) signet (>= 0.16, < 2.a) highline (2.0.3) - http-cookie (1.0.5) + http-cookie (1.0.6) domain_name (~> 0.5) httpclient (2.8.3) i18n (1.14.5) concurrent-ruby (~> 1.0) jmespath (1.6.2) json (2.7.2) - jwt (2.8.1) + jwt (2.8.2) base64 - mini_magick (4.12.0) + mini_magick (4.13.1) mini_mime (1.1.5) - minitest (5.22.3) + minitest (5.24.0) molinillo (0.8.0) multi_json (1.15.0) multipart-post (2.4.1) @@ -231,22 +232,23 @@ GEM naturally (2.2.1) netrc (0.11.0) nkf (0.2.0) - nokogiri (1.16.4-arm64-darwin) + nokogiri (1.16.6-arm64-darwin) racc (~> 1.4) - nokogiri (1.16.4-x86_64-darwin) + nokogiri (1.16.6-x86_64-darwin) racc (~> 1.4) optparse (0.5.0) os (1.1.4) plist (3.7.1) public_suffix (4.0.7) - racc (1.7.3) + racc (1.8.0) rake (13.2.1) representable (3.2.0) declarative (< 0.1.0) trailblazer-option (>= 0.1.1, < 0.2.0) uber (< 0.2.0) retriable (3.1.2) - rexml (3.2.6) + rexml (3.2.9) + strscan rouge (2.0.7) ruby-macho (2.5.1) ruby2_keywords (0.0.5) @@ -261,12 +263,13 @@ GEM simctl (1.6.10) CFPropertyList naturally - slather (2.8.0) + slather (2.8.1) CFPropertyList (>= 2.2, < 4) activesupport clamp (~> 1.3) nokogiri (>= 1.14.3) xcodeproj (~> 1.21) + strscan (3.1.0) terminal-notifier (2.0.0) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) diff --git a/README.md b/README.md index 277829fe..2711c2b7 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ Then, select the dependency rule and press **Add Package**. Add the following line to your `Podfile`: ```ruby -pod 'Auth0', '~> 2.7' +pod 'Auth0', '~> 2.8' ``` Then, run `pod install`. @@ -65,7 +65,7 @@ Then, run `pod install`. Add the following line to your `Cartfile`: ```text -github "auth0/Auth0.swift" ~> 2.7 +github "auth0/Auth0.swift" ~> 2.8 ``` Then, run `carthage bootstrap --use-xcframeworks`. diff --git a/docs/data/documentation/auth0.json b/docs/data/documentation/auth0.json index 2276d27e..58afe547 100644 --- a/docs/data/documentation/auth0.json +++ b/docs/data/documentation/auth0.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","hierarchy":{"paths":[[]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0"},"abstract":[{"type":"text","text":"SDK for Apple platforms."}],"primaryContentSections":[{"kind":"content","content":[{"level":2,"anchor":"Overview","text":"Overview","type":"heading"},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"},{"type":"text","text":": Web-based authentication client."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","isActive":true,"type":"reference"},{"text":": Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","isActive":true,"type":"reference"},{"text":": Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true,"type":"reference"},{"text":".","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true},{"type":"text","text":": Client for the Users endpoints of the Auth0 "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}]}]}]}]}],"variants":[{"paths":["\/documentation\/auth0"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents"],"generated":true,"title":"Articles"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"],"title":"Classes"},{"title":"Protocols","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"],"title":"Structures"},{"title":"Variables","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)"],"title":"Functions"},{"title":"Type Aliases","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"],"title":"Enumerations"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift"],"title":"Extended Modules"}],"sections":[],"metadata":{"externalID":"Auth0","symbolKind":"module","roleHeading":"Framework","modules":[{"name":"Auth0"}],"title":"Auth0","role":"collection"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"url":"\/documentation\/auth0\/webauthresult","role":"symbol","title":"WebAuthResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthResult"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementResult":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"ManagementResult","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementResult","kind":"identifier"}],"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Management API operations.","type":"text"}],"url":"\/documentation\/auth0\/managementresult","title":"ManagementResult","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","abstract":[],"url":"\/documentation\/auth0\/swift","title":"Swift","role":"collection","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","role":"symbol","type":"topic"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","titleInlineContent":[{"text":"Authentication API","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/authentication(clientId:domain:session:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"authentication"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier"}],"abstract":[{"text":"Auth0 ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true,"type":"reference"},{"type":"text","text":" client to authenticate your user using Database, Social, Enterprise or Passwordless connections."}],"url":"\/documentation\/auth0\/authentication(clientid:domain:session:)","title":"authentication(clientId:domain:session:)","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Logger","kind":"identifier"}],"navigatorTitle":[{"text":"Logger","kind":"identifier"}],"abstract":[{"type":"text","text":"Logger for debugging purposes."}],"url":"\/documentation\/auth0\/logger","title":"Logger","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/authentication(session:bundle:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"kind":"text","text":"("},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication"}],"abstract":[{"type":"text","text":"Auth0 "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"text":" client to authenticate your user using Database,","type":"text"},{"text":" ","type":"text"},{"text":"Social, Enterprise or Passwordless connections.","type":"text"}],"url":"\/documentation\/auth0\/authentication(session:bundle:)","title":"authentication(session:bundle:)","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"url":"\/documentation\/auth0\/useragents","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","role":"article","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"url":"\/documentation\/auth0\/telemetry","title":"Telemetry","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"url":"\/documentation\/auth0\/loggable","title":"Loggable","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(clientId:domain:session:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"webAuth","kind":"identifier"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"WebAuth","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP"}],"abstract":[{"type":"text","text":"Auth0 client for performing web-based authentication with "},{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/webauth(clientid:domain:session:)","title":"webAuth(clientId:domain:session:)","role":"symbol","type":"topic"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","title":"Universal Login","type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","titleInlineContent":[{"type":"text","text":"Universal Login"}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A multi-factor challenge."}],"url":"\/documentation\/auth0\/challenge","title":"Challenge","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:session:bundle:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"users","kind":"identifier"},{"kind":"text","text":"("},{"text":"token","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Users","preciseIdentifier":"s:5Auth05UsersP","kind":"typeIdentifier"}],"abstract":[{"text":"Auth0 ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"type":"text","text":" client to perform operations with the Users"},{"text":" ","type":"text"},{"type":"text","text":"endpoints."}],"url":"\/documentation\/auth0\/users(token:session:bundle:)","title":"users(token:session:bundle:)","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthentication"}],"navigatorTitle":[{"text":"WebAuthentication","kind":"identifier"}],"abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"url":"\/documentation\/auth0\/webauthentication","title":"WebAuthentication","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"DatabaseUser","kind":"identifier"}],"navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"url":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference"},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:domain:session:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":") -> ","kind":"text"},{"text":"Users","kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP"}],"abstract":[{"text":"Auth0 ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"type":"text","text":" client to perform operations with the Users"},{"text":" ","type":"text"},{"type":"text","text":"endpoints."}],"url":"\/documentation\/auth0\/users(token:domain:session:)","title":"users(token:domain:session:)","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationResult":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"AuthenticationResult","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationResult"}],"abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Authentication API operations.","type":"text"}],"url":"\/documentation\/auth0\/authenticationresult","title":"AuthenticationResult","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"navigatorTitle":[{"text":"WebAuthProvider","kind":"identifier"}],"abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"text":" to perform a web-based operation.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"role":"collection","abstract":[],"url":"\/documentation\/auth0\/foundation","kind":"symbol","title":"Foundation","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject","title":"ManagementObject","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","role":"collection","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"title":"WebAuthUserAgent","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"text":"Management API v2","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(session:bundle:)":{"abstract":[{"text":"Auth0 client for performing web-based authentication with ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true},{"text":".","type":"text"}],"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":", "},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth"}],"url":"\/documentation\/auth0\/webauth(session:bundle:)","title":"webAuth(session:bundle:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"url":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"abstract":[{"type":"text","text":"Callback invoked by the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"text":" when the web-based operation concludes.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthProviderCallback"}],"url":"\/documentation\/auth0\/webauthprovidercallback","navigatorTitle":[{"text":"WebAuthProviderCallback","kind":"identifier"}],"title":"WebAuthProviderCallback","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/defaultScope":{"abstract":[{"text":"Default scope value used across Auth0.swift. Equals to ","type":"text"},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"defaultScope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/defaultscope","title":"defaultScope","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"abstract":[],"kind":"article","url":"\/documentation\/auth0\/refreshtokens","title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"title":"Trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"variants":[{"paths":["\/documentation\/auth0"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"content","content":[{"level":2,"text":"Overview","anchor":"Overview","type":"heading"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","type":"reference","isActive":true},{"text":": Web-based authentication client.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","isActive":true,"type":"reference"},{"text":": Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}]}]},{"content":[{"inlineContent":[{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"},{"type":"text","text":": Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"text":".","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"type":"text","text":": Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true,"type":"reference"},{"type":"text","text":"."}]}]}],"type":"unorderedList"}]}],"metadata":{"modules":[{"name":"Auth0"}],"title":"Auth0","role":"collection","roleHeading":"Framework","externalID":"Auth0","symbolKind":"module"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0"},"topicSections":[{"title":"Articles","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents"],"generated":true},{"title":"Classes","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"],"title":"Protocols"},{"title":"Structures","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]},{"title":"Variables","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope"]},{"title":"Functions","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)"]},{"title":"Type Aliases","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"],"title":"Enumerations"},{"title":"Extended Modules","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift"]}],"hierarchy":{"paths":[[]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"url":"\/documentation\/auth0\/foundation","title":"Foundation","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","abstract":[],"role":"collection","type":"topic","kind":"symbol"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:domain:session:)":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"domain","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth05UsersP","text":"Users","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/users(token:domain:session:)","title":"users(token:domain:session:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","abstract":[{"text":"Auth0 ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"type":"text","text":" client to perform operations with the Users"},{"type":"text","text":" "},{"text":"endpoints.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(session:bundle:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP"}],"url":"\/documentation\/auth0\/webauth(session:bundle:)","title":"webAuth(session:bundle:)","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Auth0 client for performing web-based authentication with "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","type":"topic","url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"kind":"symbol","title":"Loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Loggable","kind":"identifier"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/loggable"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","role":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","kind":"symbol","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"titleInlineContent":[{"text":"Universal Login","type":"text"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"link","title":"Universal Login","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationResult":{"abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Authentication API operations."}],"navigatorTitle":[{"text":"AuthenticationResult","kind":"identifier"}],"kind":"symbol","title":"AuthenticationResult","type":"topic","role":"symbol","url":"\/documentation\/auth0\/authenticationresult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationResult"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/defaultScope":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"defaultScope"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"abstract":[{"text":"Default scope value used across Auth0.swift. Equals to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"kind":"symbol","url":"\/documentation\/auth0\/defaultscope","title":"defaultScope","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(clientId:domain:session:)":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":") -> ","kind":"text"},{"text":"WebAuth","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP"}],"url":"\/documentation\/auth0\/webauth(clientid:domain:session:)","title":"webAuth(clientId:domain:session:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","abstract":[{"text":"Auth0 client for performing web-based authentication with ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},{"text":".","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/trackable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"title":"Auth0APIError","url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthentication","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthentication","role":"symbol","title":"WebAuthentication","abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}]},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"kind":"symbol","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","type":"topic","title":"Logger","navigatorTitle":[{"kind":"identifier","text":"Logger"}],"url":"\/documentation\/auth0\/logger"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"text":" method of ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}]},"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"type":"text","text":"Management API v2"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:session:bundle:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":", "},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bundle","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth05UsersP","text":"Users","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/users(token:session:bundle:)","title":"users(token:session:bundle:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","abstract":[{"type":"text","text":"Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true,"type":"reference"},{"type":"text","text":" client to perform operations with the Users"},{"type":"text","text":" "},{"type":"text","text":"endpoints."}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"type":"topic","kind":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/authentication(session:bundle:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"text":"Bundle","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication(session:bundle:)","title":"authentication(session:bundle:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","abstract":[{"text":"Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":" client to authenticate your user using Database,"},{"text":" ","type":"text"},{"text":"Social, Enterprise or Passwordless connections.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"WebAuthProviderCallback","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthProviderCallback","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthprovidercallback","title":"WebAuthProviderCallback","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","abstract":[{"type":"text","text":"Callback invoked by the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"text":" when the web-based operation concludes.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/authentication(clientId:domain:session:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"}],"title":"authentication(clientId:domain:session:)","abstract":[{"type":"text","text":"Auth0 "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":" client to authenticate your user using Database, Social, Enterprise or Passwordless connections."}],"url":"\/documentation\/auth0\/authentication(clientid:domain:session:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthUserAgent"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"url":"\/documentation\/auth0\/useragents","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"role":"article","type":"topic","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"url":"\/documentation\/auth0\/auth0error","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"kind":"symbol","title":"Auth0Error"},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"url":"\/documentation\/auth0\/swift","title":"Swift","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","abstract":[],"role":"collection","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthProvider","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" to perform a web-based operation."},{"text":" ","type":"text"},{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" opens the URL in an external user agent and then invokes the callback when done."}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","title":"CredentialsStorage"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"role":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors","kind":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","title":"Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"kind":"symbol","url":"\/documentation\/auth0\/telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementResult":{"navigatorTitle":[{"kind":"identifier","text":"ManagementResult"}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/managementresult","type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementResult"}],"title":"ManagementResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Management API operations."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult"},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"url":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0apierror.json b/docs/data/documentation/auth0/auth0apierror.json index d81ddc5d..e11b7e1c 100644 --- a/docs/data/documentation/auth0/auth0apierror.json +++ b/docs/data/documentation/auth0/auth0apierror.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"metadata":{"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0APIError"}],"externalID":"s:5Auth00A8APIErrorP","roleHeading":"Protocol","symbolKind":"protocol","title":"Auth0APIError","role":"symbol","modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode"],"title":"Instance Properties"}],"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP"],"title":"Inherits From","type":"inheritsFrom"},{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"],"type":"conformingTypes","title":"Conforming Types"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/auth0apierror"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0APIError"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth00A5ErrorP","text":"Auth0Error","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"}],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"},"abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"type":"unresolvable","title":"Foundation.LocalizedError","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/init(info:statusCode:)":{"role":"symbol","required":true,"title":"init(info:statusCode:)","type":"topic","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)","url":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/info":{"role":"symbol","required":true,"title":"info","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","url":"\/documentation\/auth0\/auth0apierror\/info","abstract":[{"text":"Additional information about the error.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/code":{"kind":"symbol","abstract":[{"type":"text","text":"The code of the error as a string."}],"role":"symbol","required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/auth0apierror\/code","title":"code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/statusCode":{"title":"statusCode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","url":"\/documentation\/auth0\/auth0apierror\/statuscode","required":true,"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"kind":"symbol"},"doc://com.auth0.Auth0/s5ErrorP":{"type":"unresolvable","title":"Swift.Error","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable","title":"Swift.CustomDebugStringConvertible"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"},"sections":[],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode"],"title":"Instance Properties"}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP"],"kind":"relationships","title":"Inherits From","type":"inheritsFrom"},{"title":"Conforming Types","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"],"type":"conformingTypes","kind":"relationships"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0APIError"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:5Auth00A5ErrorP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","kind":"typeIdentifier","text":"Auth0Error"}],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"title":"Auth0APIError","externalID":"s:5Auth00A8APIErrorP","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0APIError"}],"roleHeading":"Protocol","symbolKind":"protocol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"title":"Auth0APIError","url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable"},"doc://com.auth0.Auth0/s5ErrorP":{"title":"Swift.Error","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"title":"Foundation.LocalizedError","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/statusCode":{"title":"statusCode","url":"\/documentation\/auth0\/auth0apierror\/statuscode","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"kind":"symbol","abstract":[{"type":"text","text":"HTTP status code of the response."}],"type":"topic","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/code":{"title":"code","url":"\/documentation\/auth0\/auth0apierror\/code","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"kind":"symbol","abstract":[{"type":"text","text":"The code of the error as a string."}],"type":"topic","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/init(info:statusCode:)":{"required":true,"type":"topic","role":"symbol","title":"init(info:statusCode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"info","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/info":{"title":"info","url":"\/documentation\/auth0\/auth0apierror\/info","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"kind":"symbol","abstract":[{"type":"text","text":"Additional information about the error."}],"type":"topic","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"url":"\/documentation\/auth0\/auth0error","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"kind":"symbol","title":"Auth0Error"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0apierror/code.json b/docs/data/documentation/auth0/auth0apierror/code.json index 01aa5836..579e78a7 100644 --- a/docs/data/documentation/auth0/auth0apierror/code.json +++ b/docs/data/documentation/auth0/auth0apierror/code.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"abstract":[{"type":"text","text":"The code of the error as a string."}],"metadata":{"externalID":"s:5Auth00A8APIErrorP4codeSSvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","required":true,"role":"symbol","symbolKind":"property","title":"code"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/code"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/code":{"kind":"symbol","abstract":[{"type":"text","text":"The code of the error as a string."}],"role":"symbol","required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/auth0apierror\/code","title":"code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","modules":[{"name":"Auth0"}],"required":true,"title":"code","externalID":"s:5Auth00A8APIErrorP4codeSSvp","roleHeading":"Instance Property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code"},"sections":[],"abstract":[{"type":"text","text":"The code of the error as a string."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"variants":[{"paths":["\/documentation\/auth0\/auth0apierror\/code"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/code":{"title":"code","url":"\/documentation\/auth0\/auth0apierror\/code","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"kind":"symbol","abstract":[{"type":"text","text":"The code of the error as a string."}],"type":"topic","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"title":"Auth0APIError","url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0apierror/info.json b/docs/data/documentation/auth0/auth0apierror/info.json index cf83c739..877968d7 100644 --- a/docs/data/documentation/auth0/auth0apierror/info.json +++ b/docs/data/documentation/auth0/auth0apierror/info.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Additional information about the error."}],"sections":[],"metadata":{"required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"externalID":"s:5Auth00A8APIErrorP4infoSDySSypGvp","modules":[{"name":"Auth0"}],"role":"symbol","title":"info","roleHeading":"Instance Property","symbolKind":"property"},"variants":[{"paths":["\/documentation\/auth0\/auth0apierror\/info"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"] { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/info":{"role":"symbol","required":true,"title":"info","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","url":"\/documentation\/auth0\/auth0apierror\/info","abstract":[{"text":"Additional information about the error.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/info"]}],"abstract":[{"text":"Additional information about the error.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info"},"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"externalID":"s:5Auth00A8APIErrorP4infoSDySSypGvp","required":true,"role":"symbol","symbolKind":"property","title":"info","roleHeading":"Instance Property","modules":[{"name":"Auth0"}]},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"] { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"title":"Auth0APIError","url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/info":{"title":"info","url":"\/documentation\/auth0\/auth0apierror\/info","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"kind":"symbol","abstract":[{"type":"text","text":"Additional information about the error."}],"type":"topic","required":true}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0apierror/init(info:statuscode:).json b/docs/data/documentation/auth0/auth0apierror/init(info:statuscode:).json index 99fe8655..d893561e 100644 --- a/docs/data/documentation/auth0/auth0apierror/init(info:statuscode:).json +++ b/docs/data/documentation/auth0/auth0apierror/init(info:statuscode:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"JSON response from Auth0."}],"type":"paragraph"}],"name":"info"},{"content":[{"inlineContent":[{"type":"text","text":"HTTP status code of the response."}],"type":"paragraph"}],"name":"statusCode"}]},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A new "},{"type":"codeVoice","code":"Auth0APIError"},{"text":".","type":"text"}]}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"variants":[{"paths":["\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Initializer","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":")","kind":"text"}],"externalID":"s:5Auth00A8APIErrorP4info10statusCodexSDySSypG_Sitcfc","required":true,"title":"init(info:statusCode:)","modules":[{"name":"Auth0"}],"role":"symbol"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/init(info:statusCode:)":{"role":"symbol","required":true,"title":"init(info:statusCode:)","type":"topic","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)","url":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"statusCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"info","content":[{"type":"paragraph","inlineContent":[{"text":"JSON response from Auth0.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP status code of the response."}]}],"name":"statusCode"}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A new "},{"type":"codeVoice","code":"Auth0APIError"},{"text":".","type":"text"}]}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"metadata":{"roleHeading":"Initializer","modules":[{"name":"Auth0"}],"required":true,"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"info","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}],"symbolKind":"init","title":"init(info:statusCode:)","role":"symbol","externalID":"s:5Auth00A8APIErrorP4info10statusCodexSDySSypG_Sitcfc"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)","interfaceLanguage":"swift"},"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/init(info:statusCode:)":{"required":true,"type":"topic","role":"symbol","title":"init(info:statusCode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"info","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"title":"Auth0APIError","url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0apierror/statuscode.json b/docs/data/documentation/auth0/auth0apierror/statuscode.json index 3cf26e3f..934f7fd3 100644 --- a/docs/data/documentation/auth0/auth0apierror/statuscode.json +++ b/docs/data/documentation/auth0/auth0apierror/statuscode.json @@ -1 +1 @@ -{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth00A8APIErrorP10statusCodeSivp","required":true,"title":"statusCode","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"roleHeading":"Instance Property","role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/auth0apierror\/statuscode"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"HTTP status code of the response."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/statusCode":{"title":"statusCode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","url":"\/documentation\/auth0\/auth0apierror\/statuscode","required":true,"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"kind":"symbol"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","interfaceLanguage":"swift"},"metadata":{"required":true,"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"statusCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"externalID":"s:5Auth00A8APIErrorP10statusCodeSivp","title":"statusCode","roleHeading":"Instance Property"},"abstract":[{"type":"text","text":"HTTP status code of the response."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/statuscode"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"title":"Auth0APIError","url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/statusCode":{"title":"statusCode","url":"\/documentation\/auth0\/auth0apierror\/statuscode","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"kind":"symbol","abstract":[{"type":"text","text":"HTTP status code of the response."}],"type":"topic","required":true}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0error.json b/docs/data/documentation/auth0/auth0error.json index 524daf6a..0dd07f52 100644 --- a/docs/data/documentation/auth0/auth0error.json +++ b/docs/data/documentation/auth0/auth0error.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"]}],"kind":"symbol","abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"relationshipsSections":[{"title":"Inherits From","type":"inheritsFrom","identifiers":["doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP"],"kind":"relationships"},{"type":"inheritedBy","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"],"title":"Inherited By","kind":"relationships"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"],"kind":"relationships","title":"Conforming Types","type":"conformingTypes"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"},{"text":" : ","kind":"text"},{"text":"LocalizedError","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation14LocalizedErrorP"},{"kind":"text","text":", "},{"text":"CustomDebugStringConvertible","preciseIdentifier":"s:s28CustomDebugStringConvertibleP","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error"]}],"sections":[],"metadata":{"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"symbolKind":"protocol","role":"symbol","modules":[{"name":"Auth0"}],"title":"Auth0Error","roleHeading":"Protocol","externalID":"s:5Auth00A5ErrorP","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/errorDescription":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/auth0error\/errordescription","title":"errorDescription","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/s5ErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","url":"\/documentation\/auth0\/auth0error\/localizeddescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","type":"topic","title":"localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-1atql":{"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any."}],"defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"required":true,"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-1atql","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"},{"text":" : ","kind":"text"},{"text":"LocalizedError","preciseIdentifier":"s:10Foundation14LocalizedErrorP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s28CustomDebugStringConvertibleP","kind":"typeIdentifier","text":"CustomDebugStringConvertible"}],"platforms":["iOS"]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error"]}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"relationshipsSections":[{"kind":"relationships","title":"Inherits From","identifiers":["doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP"],"type":"inheritsFrom"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"],"kind":"relationships","title":"Inherited By","type":"inheritedBy"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"],"title":"Conforming Types","kind":"relationships","type":"conformingTypes"}],"metadata":{"title":"Auth0Error","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Auth0Error","kind":"identifier"}],"roleHeading":"Protocol","externalID":"s:5Auth00A5ErrorP","symbolKind":"protocol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"role":"symbol"},"sections":[],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"],"title":"Instance Properties"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"localizedDescription","url":"\/documentation\/auth0\/auth0error\/localizeddescription","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/errorDescription":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/auth0error\/errordescription","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"errorDescription","abstract":[{"text":"Description of the error.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/s5ErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"url":"\/documentation\/auth0\/auth0error","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"kind":"symbol","title":"Auth0Error"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"title":"Auth0APIError","url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-1atql":{"kind":"symbol","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any."}],"type":"topic","url":"\/documentation\/auth0\/auth0error\/cause-1atql","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"?","kind":"text"}],"title":"cause","defaultImplementations":1}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0error/cause-1atql.json b/docs/data/documentation/auth0/auth0error/cause-1atql.json index ff0cd105..d94a8634 100644 --- a/docs/data/documentation/auth0/auth0error/cause-1atql.json +++ b/docs/data/documentation/auth0/auth0error/cause-1atql.json @@ -1 +1 @@ -{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any."}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/auth0error\/cause-1atql"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"],"title":"Auth0Error Implementations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","interfaceLanguage":"swift"},"metadata":{"title":"cause","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"required":true,"externalID":"s:5Auth00A5ErrorP5causes0B0_pSgvp","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-1atql":{"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any."}],"defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"required":true,"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-1atql","role":"symbol","kind":"symbol"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","interfaceLanguage":"swift"},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"],"title":"Auth0Error Implementations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"metadata":{"required":true,"symbolKind":"property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"cause","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth00A5ErrorP5causes0B0_pSgvp"},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/cause-1atql"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-1atql":{"kind":"symbol","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any."}],"type":"topic","url":"\/documentation\/auth0\/auth0error\/cause-1atql","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"?","kind":"text"}],"title":"cause","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"url":"\/documentation\/auth0\/auth0error","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"kind":"symbol","title":"Auth0Error"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0error/cause-9wuyi.json b/docs/data/documentation/auth0/auth0error/cause-9wuyi.json index b4ca9364..501986cf 100644 --- a/docs/data/documentation/auth0/auth0error/cause-9wuyi.json +++ b/docs/data/documentation/auth0/auth0error/cause-9wuyi.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql"]]},"metadata":{"symbolKind":"property","title":"cause","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"extendedModule":"Auth0","roleHeading":"Instance Property","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth00A5ErrorPAAE5causes0B0_pSgvp"},"variants":[{"paths":["\/documentation\/auth0\/auth0error\/cause-9wuyi"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-1atql":{"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any."}],"defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"required":true,"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-1atql","role":"symbol","kind":"symbol"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql"]]},"variants":[{"paths":["\/documentation\/auth0\/auth0error\/cause-9wuyi"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"symbolKind":"property","externalID":"s:5Auth00A5ErrorPAAE5causes0B0_pSgvp","role":"symbol","title":"cause"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-1atql":{"kind":"symbol","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any."}],"type":"topic","url":"\/documentation\/auth0\/auth0error\/cause-1atql","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-1atql","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"?","kind":"text"}],"title":"cause","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"url":"\/documentation\/auth0\/auth0error","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"kind":"symbol","title":"Auth0Error"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0error/errordescription.json b/docs/data/documentation/auth0/auth0error/errordescription.json index 7bf30579..889dd056 100644 --- a/docs/data/documentation/auth0/auth0error/errordescription.json +++ b/docs/data/documentation/auth0/auth0error/errordescription.json @@ -1 +1 @@ -{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/errordescription"]}],"metadata":{"symbolKind":"property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","roleHeading":"Instance Property","title":"errorDescription","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"type":"aside","name":"Important","content":[{"inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"type":"text","text":" only."}],"type":"paragraph"}],"style":"important"}]}],"abstract":[{"type":"text","text":"Description of the error."}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/errorDescription":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/auth0error\/errordescription","title":"errorDescription","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"errorDescription"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"type":"aside","name":"Important","style":"important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"text":" only.","type":"text"}]}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"Description of the error.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/errordescription"]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"url":"\/documentation\/auth0\/auth0error","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"kind":"symbol","title":"Auth0Error"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/errorDescription":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/auth0error\/errordescription","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"errorDescription","abstract":[{"text":"Description of the error.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0error/localizeddescription.json b/docs/data/documentation/auth0/auth0error/localizeddescription.json index b4bf0896..d86ba9d0 100644 --- a/docs/data/documentation/auth0/auth0error/localizeddescription.json +++ b/docs/data/documentation/auth0/auth0error/localizeddescription.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"style":"important","name":"Important","type":"aside","content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"text":"debugging","type":"text"}]},{"type":"text","text":" only."}],"type":"paragraph"}]}]}],"abstract":[{"text":"Description of the error.","type":"text"}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/auth0error\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","metadata":{"symbolKind":"property","extendedModule":"Auth0","roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"modules":[{"name":"Auth0"}],"title":"localizedDescription"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","url":"\/documentation\/auth0\/auth0error\/localizeddescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","type":"topic","title":"localizedDescription"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/localizeddescription"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"text":"debugging","type":"text"}]},{"text":" only.","type":"text"}],"type":"paragraph"}],"name":"Important","style":"important","type":"aside"}]}],"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","title":"localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"symbolKind":"property","role":"symbol","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"url":"\/documentation\/auth0\/auth0error","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"kind":"symbol","title":"Auth0Error"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"localizedDescription","url":"\/documentation\/auth0\/auth0error\/localizeddescription","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication(clientid:domain:session:).json b/docs/data/documentation/auth0/authentication(clientid:domain:session:).json index 88c599c9..2c7655ec 100644 --- a/docs/data/documentation/auth0/authentication(clientid:domain:session:).json +++ b/docs/data/documentation/auth0/authentication(clientid:domain:session:).json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/authentication(clientid:domain:session:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"metadata":{"symbolKind":"func","externalID":"s:5Auth014authentication8clientId6domain7sessionAA14Authentication_pSS_SSSo12NSURLSessionCtF","modules":[{"name":"Auth0"}],"role":"symbol","title":"authentication(clientId:domain:session:)","roleHeading":"Function","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":") -> ","kind":"text"},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"}]},"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Auth0 ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":" client to authenticate your user using Database, Social, Enterprise or Passwordless connections."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":" = .shared) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","kind":"typeIdentifier"}]}],"kind":"declarations"},{"parameters":[{"name":"clientId","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Client ID of your Auth0 application."}]}]},{"name":"domain","content":[{"inlineContent":[{"text":"Domain of your Auth0 account, for example ","type":"text"},{"type":"codeVoice","code":"samples.us.auth0.com"},{"type":"text","text":"."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"URLSession"},{"text":" instance used for networking. Defaults to ","type":"text"},{"code":"URLSession.shared","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"session"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"inlineContent":[{"type":"text","text":"Auth0 Authentication API client."}],"type":"paragraph"}]},{"content":[{"anchor":"Usage","text":"Usage","level":2,"type":"heading"},{"type":"codeListing","syntax":"swift","code":["Auth0.authentication(clientId: \"client-id\", domain: \"samples.us.auth0.com\")"]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"https://auth0.com/docs/api/authentication":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/authentication(clientId:domain:session:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"authentication"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier"}],"abstract":[{"text":"Auth0 ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true,"type":"reference"},{"type":"text","text":" client to authenticate your user using Database, Social, Enterprise or Passwordless connections."}],"url":"\/documentation\/auth0\/authentication(clientid:domain:session:)","title":"authentication(clientId:domain:session:)","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication(clientid:domain:session:)"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP"}],"title":"authentication(clientId:domain:session:)","externalID":"s:5Auth014authentication8clientId6domain7sessionAA14Authentication_pSS_SSSo12NSURLSessionCtF","role":"symbol","symbolKind":"func","modules":[{"name":"Auth0"}],"roleHeading":"Function"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":" = .shared) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Client ID of your Auth0 application."}]}],"name":"clientId"},{"name":"domain","content":[{"inlineContent":[{"type":"text","text":"Domain of your Auth0 account, for example "},{"type":"codeVoice","code":"samples.us.auth0.com"},{"text":".","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"code":"URLSession","type":"codeVoice"},{"type":"text","text":" instance used for networking. Defaults to "},{"code":"URLSession.shared","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"session"}]},{"content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"inlineContent":[{"text":"Auth0 Authentication API client.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"syntax":"swift","code":["Auth0.authentication(clientId: \"client-id\", domain: \"samples.us.auth0.com\")"],"type":"codeListing"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"Auth0 ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":" client to authenticate your user using Database, Social, Enterprise or Passwordless connections."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/authentication(clientId:domain:session:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"}],"title":"authentication(clientId:domain:session:)","abstract":[{"type":"text","text":"Auth0 "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":" client to authenticate your user using Database, Social, Enterprise or Passwordless connections."}],"url":"\/documentation\/auth0\/authentication(clientid:domain:session:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication(session:bundle:).json b/docs/data/documentation/auth0/authentication(session:bundle:).json index dc1fa443..d7d41950 100644 --- a/docs/data/documentation/auth0/authentication(session:bundle:).json +++ b/docs/data/documentation/auth0/authentication(session:bundle:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication(session:bundle:)"]}],"abstract":[{"type":"text","text":"Auth0 "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"text":" client to authenticate your user using Database,","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Social, Enterprise or Passwordless connections."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"authentication"},{"text":"(","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":" = .shared, ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"text":" = .main) -> ","kind":"text"},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"},{"code":"URLSession","type":"codeVoice"},{"type":"text","text":" instance used for networking. Defaults to "},{"type":"codeVoice","code":"URLSession.shared"},{"text":".","type":"text"}]}],"name":"session"},{"name":"bundle","content":[{"inlineContent":[{"type":"text","text":"Bundle used to locate the "},{"type":"codeVoice","code":"Auth0.plist"},{"text":" file. Defaults to ","type":"text"},{"type":"codeVoice","code":"Bundle.main"},{"text":".","type":"text"}],"type":"paragraph"}]}]},{"content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"Auth0 Authentication API client."}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"syntax":"swift","code":["Auth0.authentication()"],"type":"codeListing"},{"inlineContent":[{"text":"The Auth0 Client ID & Domain are loaded from the ","type":"text"},{"type":"codeVoice","code":"Auth0.plist"},{"text":" file in your main bundle. It should have the following","type":"text"},{"type":"text","text":" "},{"text":"content:","type":"text"}],"type":"paragraph"},{"type":"codeListing","code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"],"syntax":"xml"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Calling this method without a valid "},{"code":"Auth0.plist","type":"codeVoice"},{"type":"text","text":" file will crash your application."}]}],"name":"Warning","type":"aside","style":"warning"}],"kind":"content"}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","interfaceLanguage":"swift"},"metadata":{"title":"authentication(session:bundle:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"kind":"text","text":") -> "},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"}],"externalID":"s:5Auth014authentication7session6bundleAA14Authentication_pSo12NSURLSessionC_So8NSBundleCtF","symbolKind":"func","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Function"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/authentication(session:bundle:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"kind":"text","text":"("},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication"}],"abstract":[{"type":"text","text":"Auth0 "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"text":" client to authenticate your user using Database,","type":"text"},{"text":" ","type":"text"},{"text":"Social, Enterprise or Passwordless connections.","type":"text"}],"url":"\/documentation\/auth0\/authentication(session:bundle:)","title":"authentication(session:bundle:)","role":"symbol","type":"topic"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/authentication(session:bundle:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"func","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP"}],"externalID":"s:5Auth014authentication7session6bundleAA14Authentication_pSo12NSURLSessionC_So8NSBundleCtF","title":"authentication(session:bundle:)","roleHeading":"Function"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)"},"abstract":[{"text":"Auth0 ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true,"type":"reference"},{"text":" client to authenticate your user using Database,","type":"text"},{"text":" ","type":"text"},{"text":"Social, Enterprise or Passwordless connections.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":" = .shared, "},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"text":" = .main) -> ","kind":"text"},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"session","content":[{"inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"URLSession"},{"type":"text","text":" instance used for networking. Defaults to "},{"code":"URLSession.shared","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"Bundle used to locate the ","type":"text"},{"code":"Auth0.plist","type":"codeVoice"},{"type":"text","text":" file. Defaults to "},{"code":"Bundle.main","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"bundle"}]},{"content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"Auth0 Authentication API client.","type":"text"}]}],"kind":"content"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0.authentication()"]},{"inlineContent":[{"type":"text","text":"The Auth0 Client ID & Domain are loaded from the "},{"type":"codeVoice","code":"Auth0.plist"},{"text":" file in your main bundle. It should have the following","type":"text"},{"type":"text","text":" "},{"type":"text","text":"content:"}],"type":"paragraph"},{"syntax":"xml","type":"codeListing","code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"]},{"style":"warning","name":"Warning","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"Calling this method without a valid ","type":"text"},{"code":"Auth0.plist","type":"codeVoice"},{"text":" file will crash your application.","type":"text"}]}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/authentication(session:bundle:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"text":"Bundle","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication(session:bundle:)","title":"authentication(session:bundle:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","abstract":[{"text":"Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":" client to authenticate your user using Database,"},{"text":" ","type":"text"},{"text":"Social, Enterprise or Passwordless connections.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication.json b/docs/data/documentation/auth0/authentication.json index da0ab3ab..dbe39da5 100644 --- a/docs/data/documentation/auth0/authentication.json +++ b/docs/data/documentation/auth0/authentication.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication"]}],"sections":[],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"},{"text":" : ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","preciseIdentifier":"s:5Auth08LoggableP","text":"Loggable","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Trackable","preciseIdentifier":"s:5Auth09TrackableP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"}],"languages":["swift"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"protocol","externalID":"s:5Auth014AuthenticationP","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"title":"Authentication","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}],"roleHeading":"Protocol"},"abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"text":".","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url"]},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)"]}],"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"title":"Inherits From","type":"inheritsFrom"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-56xbe":{"required":true,"defaultImplementations":1,"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe","title":"startPasswordless(email:type:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","abstract":[{"type":"text","text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the"},{"type":"text","text":" "},{"type":"text","text":"passwordless login flow."}]},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","title":"session info access token","type":"link","url":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","titleInlineContent":[{"text":"session info access token","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withRecoveryCode:mfaToken:)":{"abstract":[{"text":"Verifies multi-factor authentication (MFA) using a recovery code.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to"},{"text":" ","type":"text"},{"text":"authenticate when the user’s enrolled device is unavailable, or the user cannot receive the challenge or accept","type":"text"},{"text":" ","type":"text"},{"text":"it due to connectivity issues.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","title":"login(withRecoveryCode:mfaToken:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"withRecoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-2llyg":{"abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","title":"renew(withRefreshToken:scope:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol","defaultImplementations":1},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"login(facebookSessionAccessToken:profile:audience:scope:)","abstract":[{"text":"Authenticates a user with their Facebook ","type":"text"},{"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","isActive":true,"type":"reference"},{"text":" and profile data.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g","type":"topic","defaultImplementations":1,"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn":{"abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"type":"topic","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","defaultImplementations":1,"kind":"symbol","required":true,"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"loginDefaultDirectory","kind":"identifier"},{"kind":"text","text":"("},{"text":"withUsername","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"url":"\/documentation\/auth0\/loggable","title":"Loggable","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-38nv0":{"required":true,"title":"login(phoneNumber:code:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","defaultImplementations":1,"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/resetPassword(email:connection:)":{"abstract":[{"type":"text","text":"Resets the password of a database user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)","title":"resetPassword(email:connection:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"resetPassword"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/jwks()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","kind":"symbol","title":"jwks()","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"text":"JWKS","preciseIdentifier":"s:5Auth04JWKSV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/jwks()","abstract":[{"text":"Returns JSON Web Key Set (JWKS) information from the ","type":"text"},{"code":"\/.well-known\/jwks.json","type":"codeVoice"},{"type":"text","text":" endpoint."}],"required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo":{"required":true,"type":"topic","role":"symbol","defaultImplementations":1,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-587bo":{"abstract":[{"text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login","type":"text"},{"type":"text","text":" "},{"text":"flow.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","title":"login(email:code:audience:scope:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/clientId":{"abstract":[{"type":"text","text":"The Auth0 Client ID."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/clientid","title":"clientId","required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/codeExchange(withCode:codeVerifier:redirectURI:)":{"abstract":[{"text":"Performs the last step of Proof Key for Code Exchange (PKCE).","type":"text"},{"type":"text","text":" "},{"text":"This will request the user’s tokens using the code and its verifier after a request to ","type":"text"},{"code":"\/oauth\/authorize","type":"codeVoice"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)","title":"codeExchange(withCode:codeVerifier:redirectURI:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"codeExchange","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withCode"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"codeVerifier","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"redirectURI","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/revoke(refreshToken:)":{"abstract":[{"type":"text","text":"Revokes a user’s refresh token by performing a request to the "},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)","title":"revoke(refreshToken:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOTP:mfaToken:)":{"abstract":[{"text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP).","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","title":"login(withOTP:mfaToken:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withOTP"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3r1t9":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"defaultImplementations":1,"title":"login(withOOBCode:mfaToken:bindingCode:)"},"https://auth0.com/docs/api/authentication#standard-error-responses":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses","type":"link","title":"Standard Error Responses","url":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses","titleInlineContent":[{"text":"Standard Error Responses","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"title":"Trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w":{"abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","required":true,"type":"topic","role":"symbol","defaultImplementations":1,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"realmOrConnection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-9unt":{"abstract":[{"text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless","type":"text"},{"type":"text","text":" "},{"type":"text","text":"login flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt","title":"startPasswordless(phoneNumber:type:connection:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)","role":"symbol","kind":"symbol","type":"topic","title":"userInfo(withAccessToken:)","required":true,"abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"text":" endpoint.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"kind":"text","text":"("},{"text":"withAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"UserInfo","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y":{"kind":"symbol","type":"topic","required":true,"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"signup","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"text":"rootAttributes","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Creates a user in a database connection."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692":{"required":true,"title":"multifactorChallenge(mfaToken:types:authenticatorId:)","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","role":"symbol","defaultImplementations":1,"abstract":[{"text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the","type":"text"},{"text":" ","type":"text"},{"text":"application and user.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"multifactorChallenge"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]?, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/url":{"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/url","title":"url","required":true,"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"}}} \ No newline at end of file +{"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"title":"Inherits From","type":"inheritsFrom","kind":"relationships"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"role":"symbol","title":"Authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"symbolKind":"protocol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP","roleHeading":"Protocol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"text":".","type":"text"}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url"]},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)"]}],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"},{"kind":"text","text":" : "},{"text":"Loggable","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08LoggableP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},{"kind":"text","text":", "},{"text":"Trackable","preciseIdentifier":"s:5Auth09TrackableP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"https://auth0.com/docs/api/authentication#standard-error-responses":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses","titleInlineContent":[{"type":"text","text":"Standard Error Responses"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses","type":"link","title":"Standard Error Responses"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:)":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userInfo"},{"text":"(","kind":"text"},{"text":"withAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)","abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"type":"text","text":" endpoint."}],"required":true,"type":"topic","role":"symbol","title":"userInfo(withAccessToken:)"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/codeExchange(withCode:codeVerifier:redirectURI:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"codeExchange"},{"text":"(","kind":"text"},{"text":"withCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"codeVerifier","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"redirectURI"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","abstract":[{"text":"Performs the last step of Proof Key for Code Exchange (PKCE).","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This will request the user’s tokens using the code and its verifier after a request to "},{"type":"codeVoice","code":"\/oauth\/authorize"},{"text":".","type":"text"}],"required":true,"type":"topic","role":"symbol","title":"codeExchange(withCode:codeVerifier:redirectURI:)"},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"url":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","titleInlineContent":[{"text":"session info access token","type":"text"}],"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","type":"link","title":"session info access token"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"appleAuthorizationCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier","text":"PersonNameComponents"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","abstract":[{"text":"Authenticates a user with their Sign In with Apple authorization code.","type":"text"}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3r1t9":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","title":"login(withOOBCode:mfaToken:bindingCode:)","abstract":[{"text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"or voice)."}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOTP:mfaToken:)":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"withOTP","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","title":"login(withOTP:mfaToken:)","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP)."}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/revoke(refreshToken:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","role":"symbol","abstract":[{"type":"text","text":"Revokes a user’s refresh token by performing a request to the "},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint."}],"type":"topic","title":"revoke(refreshToken:)","url":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)","kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/url":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"url":"\/documentation\/auth0\/authentication\/url","title":"url","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/trackable"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-9unt":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"kind":"text","text":": "},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt","title":"startPasswordless(phoneNumber:type:connection:)","abstract":[{"type":"text","text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless"},{"type":"text","text":" "},{"type":"text","text":"login flow."}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-587bo":{"role":"symbol","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","title":"login(email:code:audience:scope:)","kind":"symbol","type":"topic","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","abstract":[{"type":"text","text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login"},{"type":"text","text":" "},{"type":"text","text":"flow."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-2llyg":{"abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"required":true,"defaultImplementations":1,"kind":"symbol","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg","title":"renew(withRefreshToken:scope:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g":{"abstract":[{"type":"text","text":"Authenticates a user with their Facebook "},{"type":"reference","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","isActive":true},{"type":"text","text":" and profile data."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"title":"login(facebookSessionAccessToken:profile:audience:scope:)","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","kind":"symbol","role":"symbol","required":true,"type":"topic","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-38nv0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","title":"login(phoneNumber:code:audience:scope:)","abstract":[{"type":"text","text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"kind":"symbol","title":"Loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Loggable","kind":"identifier"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/loggable"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"username"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]?, ","kind":"text"},{"text":"rootAttributes","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","abstract":[{"text":"Creates a user in a database connection.","type":"text"}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/clientId":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/authentication\/clientid","title":"clientId","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/jwks()":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"jwks"},{"text":"() -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"JWKS","preciseIdentifier":"s:5Auth04JWKSV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/jwks()","title":"jwks()","abstract":[{"type":"text","text":"Returns JSON Web Key Set (JWKS) information from the "},{"type":"codeVoice","code":"\/.well-known\/jwks.json"},{"type":"text","text":" endpoint."}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-56xbe":{"required":true,"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"defaultImplementations":1,"title":"startPasswordless(email:type:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe","abstract":[{"text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the","type":"text"},{"type":"text","text":" "},{"text":"passwordless login flow.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withUsername"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"multifactorChallenge"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","abstract":[{"text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"application and user."}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withRecoveryCode:mfaToken:)":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withRecoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","title":"login(withRecoveryCode:mfaToken:)","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a recovery code."},{"type":"text","text":" "},{"type":"text","text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to"},{"text":" ","type":"text"},{"type":"text","text":"authenticate when the user’s enrolled device is unavailable, or the user cannot receive the challenge or accept"},{"type":"text","text":" "},{"text":"it due to connectivity issues.","type":"text"}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/resetPassword(email:connection:)":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"resetPassword","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)","title":"resetPassword(email:connection:)","abstract":[{"text":"Resets the password of a database user.","type":"text"}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","role":"symbol","defaultImplementations":1,"abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","kind":"symbol","type":"topic","required":true}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/clientid.json b/docs/data/documentation/auth0/authentication/clientid.json index 71a815ba..c484011d 100644 --- a/docs/data/documentation/auth0/authentication/clientid.json +++ b/docs/data/documentation/auth0/authentication/clientid.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/clientid"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","interfaceLanguage":"swift"},"abstract":[{"text":"The Auth0 Client ID.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"kind":"symbol","metadata":{"title":"clientId","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"required":true,"roleHeading":"Instance Property","externalID":"s:5Auth014AuthenticationP8clientIdSSvp","symbolKind":"property","role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/clientId":{"abstract":[{"type":"text","text":"The Auth0 Client ID."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/clientid","title":"clientId","required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol"},"https://auth0.com/docs/api/authentication":{"type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/authentication\/clientid"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"The Auth0 Client ID.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"metadata":{"title":"clientId","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","symbolKind":"property","externalID":"s:5Auth014AuthenticationP8clientIdSSvp","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/clientId":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/authentication\/clientid","title":"clientId","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"required":true,"role":"symbol"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/codeexchange(withcode:codeverifier:redirecturi:).json b/docs/data/documentation/auth0/authentication/codeexchange(withcode:codeverifier:redirecturi:).json index d3785a1f..ec1bbbdf 100644 --- a/docs/data/documentation/auth0/authentication/codeexchange(withcode:codeverifier:redirecturi:).json +++ b/docs/data/documentation/auth0/authentication/codeexchange(withcode:codeverifier:redirecturi:).json @@ -1 +1 @@ -{"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authorization-code-flow-with-pkce45","https:\/\/tools.ietf.org\/html\/rfc7636"],"title":"Related Documentation"}],"kind":"symbol","abstract":[{"type":"text","text":"Performs the last step of Proof Key for Code Exchange (PKCE)."},{"type":"text","text":" "},{"type":"text","text":"This will request the user’s tokens using the code and its verifier after a request to "},{"code":"\/oauth\/authorize","type":"codeVoice"},{"text":".","type":"text"}],"metadata":{"role":"symbol","externalID":"s:5Auth014AuthenticationP12codeExchange8withCode0C8Verifier11redirectURIAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2StF","roleHeading":"Instance Method","title":"codeExchange(withCode:codeVerifier:redirectURI:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"codeExchange","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"codeVerifier","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"redirectURI","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"required":true,"modules":[{"name":"Auth0"}],"symbolKind":"method"},"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"codeExchange","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withCode"},{"text":" ","kind":"text"},{"text":"code","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"codeVerifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"redirectURI","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"code","content":[{"type":"paragraph","inlineContent":[{"text":"Code returned after a request to ","type":"text"},{"type":"codeVoice","code":"\/oauth\/authorize"},{"text":".","type":"text"}]}]},{"name":"codeVerifier","content":[{"inlineContent":[{"type":"text","text":"Verifier used to generate the challenge sent in the request to "},{"type":"codeVoice","code":"\/oauth\/authorize"},{"text":".","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Redirect URI sent in the request to "},{"type":"codeVoice","code":"\/oauth\/authorize"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"redirectURI"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}]},{"kind":"content","content":[{"anchor":"Usage","level":2,"type":"heading","text":"Usage"},{"type":"codeListing","code":["Auth0"," .authentication()"," .codeExchange(withCode: \"code\","," codeVerifier: \"code-verifier\","," redirectURI: \"https:\/\/samples.auth0.com\/callback\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"}]}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"https://tools.ietf.org/html/rfc7636":{"url":"https:\/\/tools.ietf.org\/html\/rfc7636","type":"link","identifier":"https:\/\/tools.ietf.org\/html\/rfc7636","title":"RFC 7636","titleInlineContent":[{"type":"text","text":"RFC 7636"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/codeExchange(withCode:codeVerifier:redirectURI:)":{"abstract":[{"text":"Performs the last step of Proof Key for Code Exchange (PKCE).","type":"text"},{"type":"text","text":" "},{"text":"This will request the user’s tokens using the code and its verifier after a request to ","type":"text"},{"code":"\/oauth\/authorize","type":"codeVoice"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)","title":"codeExchange(withCode:codeVerifier:redirectURI:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"codeExchange","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withCode"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"codeVerifier","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"redirectURI","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"role":"symbol"},"https://auth0.com/docs/api/authentication#authorization-code-flow-with-pkce45":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#authorization-code-flow-with-pkce45","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authorization-code-flow-with-pkce45","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint"}}} \ No newline at end of file +{"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authorization-code-flow-with-pkce45","https:\/\/tools.ietf.org\/html\/rfc7636"]}],"metadata":{"title":"codeExchange(withCode:codeVerifier:redirectURI:)","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"codeExchange"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"codeVerifier","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"redirectURI","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol","required":true,"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP12codeExchange8withCode0C8Verifier11redirectURIAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2StF"},"kind":"symbol","sections":[],"abstract":[{"type":"text","text":"Performs the last step of Proof Key for Code Exchange (PKCE)."},{"text":" ","type":"text"},{"type":"text","text":"This will request the user’s tokens using the code and its verifier after a request to "},{"type":"codeVoice","code":"\/oauth\/authorize"},{"type":"text","text":"."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"codeExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withCode"},{"text":" ","kind":"text"},{"text":"code","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"codeVerifier","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"redirectURI"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"code","content":[{"inlineContent":[{"type":"text","text":"Code returned after a request to "},{"type":"codeVoice","code":"\/oauth\/authorize"},{"text":".","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Verifier used to generate the challenge sent in the request to "},{"code":"\/oauth\/authorize","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"codeVerifier"},{"content":[{"inlineContent":[{"text":"Redirect URI sent in the request to ","type":"text"},{"code":"\/oauth\/authorize","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"redirectURI"}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"code":["Auth0"," .authentication()"," .codeExchange(withCode: \"code\","," codeVerifier: \"code-verifier\","," redirectURI: \"https:\/\/samples.auth0.com\/callback\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/codeExchange(withCode:codeVerifier:redirectURI:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"codeExchange"},{"text":"(","kind":"text"},{"text":"withCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"codeVerifier","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"redirectURI"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","abstract":[{"text":"Performs the last step of Proof Key for Code Exchange (PKCE).","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This will request the user’s tokens using the code and its verifier after a request to "},{"type":"codeVoice","code":"\/oauth\/authorize"},{"text":".","type":"text"}],"required":true,"type":"topic","role":"symbol","title":"codeExchange(withCode:codeVerifier:redirectURI:)"},"https://tools.ietf.org/html/rfc7636":{"type":"link","titleInlineContent":[{"type":"text","text":"RFC 7636"}],"identifier":"https:\/\/tools.ietf.org\/html\/rfc7636","url":"https:\/\/tools.ietf.org\/html\/rfc7636","title":"RFC 7636"},"https://auth0.com/docs/api/authentication#authorization-code-flow-with-pkce45":{"type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authorization-code-flow-with-pkce45","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#authorization-code-flow-with-pkce45"},"https://auth0.com/docs/api/authentication":{"type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/jwks().json b/docs/data/documentation/auth0/authentication/jwks().json index 5dd28356..0b7b02c1 100644 --- a/docs/data/documentation/auth0/authentication/jwks().json +++ b/docs/data/documentation/auth0/authentication/jwks().json @@ -1 +1 @@ -{"metadata":{"roleHeading":"Instance Method","title":"jwks()","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth04JWKSV","text":"JWKS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationP4jwksAA7RequestVyAA4JWKSVAA0B5ErrorVGyF","role":"symbol","symbolKind":"method","required":true},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"jwks","kind":"identifier"},{"kind":"text","text":"() -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"JWKS","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","kind":"typeIdentifier","preciseIdentifier":"s:5Auth04JWKSV"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"text":"Return Value","anchor":"return-value","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield JWKS information.","type":"text"}]}],"kind":"content"},{"content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"code":["Auth0"," .authentication()"," .jwks()"," .start { result in"," switch result {"," case .success(let jwks):"," print(\"Obtained JWKS: \\(jwks)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"}],"kind":"content"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/jwks()"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()"},"sections":[],"abstract":[{"type":"text","text":"Returns JSON Web Key Set (JWKS) information from the "},{"type":"codeVoice","code":"\/.well-known\/jwks.json"},{"type":"text","text":" endpoint."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/jwks()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","kind":"symbol","title":"jwks()","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"text":"JWKS","preciseIdentifier":"s:5Auth04JWKSV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/jwks()","abstract":[{"text":"Returns JSON Web Key Set (JWKS) information from the ","type":"text"},{"code":"\/.well-known\/jwks.json","type":"codeVoice"},{"type":"text","text":" endpoint."}],"required":true,"type":"topic"},"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-key-sets":{"titleInlineContent":[{"text":"JSON Web Key Sets","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets","type":"link","title":"JSON Web Key Sets","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"https://auth0.com/docs/api/authentication":{"type":"link","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","sections":[],"abstract":[{"type":"text","text":"Returns JSON Web Key Set (JWKS) information from the "},{"type":"codeVoice","code":"\/.well-known\/jwks.json"},{"text":" endpoint.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/jwks()"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"jwks"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth04JWKSV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","text":"JWKS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield JWKS information."}]}]},{"kind":"content","content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .jwks()"," .start { result in"," switch result {"," case .success(let jwks):"," print(\"Obtained JWKS: \\(jwks)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}]}],"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth04JWKSV","text":"JWKS"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationP4jwksAA7RequestVyAA4JWKSVAA0B5ErrorVGyF","title":"jwks()","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol","required":true},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/jwks()":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"jwks"},{"text":"() -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"JWKS","preciseIdentifier":"s:5Auth04JWKSV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/jwks()","title":"jwks()","abstract":[{"type":"text","text":"Returns JSON Web Key Set (JWKS) information from the "},{"type":"codeVoice","code":"\/.well-known\/jwks.json"},{"type":"text","text":" endpoint."}],"required":true,"role":"symbol"},"https://auth0.com/docs/api/authentication":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-key-sets":{"type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets","titleInlineContent":[{"type":"text","text":"JSON Web Key Sets"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets","title":"JSON Web Key Sets"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m.json b/docs/data/documentation/auth0/authentication/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m.json index 68bfc4c6..53e290f8 100644 --- a/docs/data/documentation/auth0/authentication/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m.json +++ b/docs/data/documentation/auth0/authentication/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m.json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"appleAuthorizationCode","kind":"externalParam"},{"kind":"text","text":" "},{"text":"authorizationCode","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"fullName","kind":"externalParam"},{"kind":"text","text":": "},{"text":"PersonNameComponents","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"text":"? = nil, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]? = nil, "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" = defaultScope) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"authorizationCode","content":[{"type":"paragraph","inlineContent":[{"text":"Authorization Code retrieved from Apple Authorization.","type":"text"}]}]},{"name":"fullName","content":[{"inlineContent":[{"text":"The full name property returned with the Apple ID Credentials.","type":"text"}],"type":"paragraph"}]},{"name":"profile","content":[{"inlineContent":[{"text":"Additional user profile data returned with the Apple ID Credentials.","type":"text"}],"type":"paragraph"}]},{"name":"audience","content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"scope"}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}]},{"content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(appleAuthorizationCode: \"auth-code\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"type":"paragraph"},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(appleAuthorizationCode: \"auth-code\","," fullName: credentials.fullName,"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"syntax":"swift"}],"kind":"content"}],"metadata":{"externalID":"s:5Auth014AuthenticationPAAE5login22appleAuthorizationCode8fullName7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_10Foundation06PersonH10ComponentsVSgSDySSypGSgSSSgSStF","modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"method","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]?, "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"extendedModule":"Auth0","roleHeading":"Instance Method"},"abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"],"title":"Related Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}]},"https://auth0.com/docs/api/authentication#token-exchange-for-native-social":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo":{"required":true,"type":"topic","role":"symbol","defaultImplementations":1,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}]},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo"]]},"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"text":" ","kind":"text"},{"text":"authorizationCode","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]? = nil, "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" = defaultScope) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Authorization Code retrieved from Apple Authorization.","type":"text"}]}],"name":"authorizationCode"},{"content":[{"type":"paragraph","inlineContent":[{"text":"The full name property returned with the Apple ID Credentials.","type":"text"}]}],"name":"fullName"},{"name":"profile","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional user profile data returned with the Apple ID Credentials."}]}]},{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"scope"}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}],"kind":"content"},{"content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"code":["Auth0"," .authentication()"," .login(appleAuthorizationCode: \"auth-code\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}]},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(appleAuthorizationCode: \"auth-code\","," fullName: credentials.fullName,"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing"}],"kind":"content"}],"metadata":{"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","role":"symbol","externalID":"s:5Auth014AuthenticationPAAE5login22appleAuthorizationCode8fullName7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_10Foundation06PersonH10ComponentsVSgSDySSypGSgSSSgSStF","symbolKind":"method","extendedModule":"Auth0","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]},"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m"},"sections":[],"abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m":{"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m","kind":"symbol","abstract":[{"text":"Authenticates a user with their Sign In with Apple authorization code.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"appleAuthorizationCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier","text":"PersonNameComponents"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","abstract":[{"text":"Authenticates a user with their Sign In with Apple authorization code.","type":"text"}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"https://auth0.com/docs/api/authentication#token-exchange-for-native-social":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo.json b/docs/data/documentation/auth0/authentication/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo.json index 5a14c16a..77f8a6e9 100644 --- a/docs/data/documentation/auth0/authentication/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo.json +++ b/docs/data/documentation/auth0/authentication/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"required":true,"role":"symbol","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"appleAuthorizationCode"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"profile"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationP5login22appleAuthorizationCode8fullName7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_10Foundation06PersonH10ComponentsVSgSDySSypGSgSSSgSStF","roleHeading":"Instance Method","symbolKind":"method"},"abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":" "},{"text":"authorizationCode","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"kind":"text","text":": "},{"text":"PersonNameComponents","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]?, "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"parameters":[{"name":"authorizationCode","content":[{"inlineContent":[{"text":"Authorization Code retrieved from Apple Authorization.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"The full name property returned with the Apple ID Credentials.","type":"text"}]}],"name":"fullName"},{"content":[{"inlineContent":[{"type":"text","text":"Additional user profile data returned with the Apple ID Credentials."}],"type":"paragraph"}],"name":"profile"},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}]}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}]}]}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .login(appleAuthorizationCode: \"auth-code\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(appleAuthorizationCode: \"auth-code\","," fullName: credentials.fullName,"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]}],"kind":"content"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo":{"required":true,"type":"topic","role":"symbol","defaultImplementations":1,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}]},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"https://auth0.com/docs/api/authentication#token-exchange-for-native-social":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m"]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"appleAuthorizationCode","kind":"externalParam"},{"kind":"text","text":" "},{"text":"authorizationCode","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"fullName","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"authorizationCode","content":[{"inlineContent":[{"type":"text","text":"Authorization Code retrieved from Apple Authorization."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"The full name property returned with the Apple ID Credentials.","type":"text"}],"type":"paragraph"}],"name":"fullName"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional user profile data returned with the Apple ID Credentials.","type":"text"}]}],"name":"profile"},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"name":"audience"},{"name":"scope","content":[{"inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}]},{"content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(appleAuthorizationCode: \"auth-code\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"code":["Auth0"," .authentication()"," .login(appleAuthorizationCode: \"auth-code\","," fullName: credentials.fullName,"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"syntax":"swift","type":"codeListing"}],"kind":"content"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"symbolKind":"method","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","roleHeading":"Instance Method","required":true,"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP5login22appleAuthorizationCode8fullName7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_10Foundation06PersonH10ComponentsVSgSDySSypGSgSSSgSStF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"fullName","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol"},"kind":"symbol","abstract":[{"type":"text","text":"Authenticates a user with their Sign In with Apple authorization code."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-7k4xo","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"appleAuthorizationCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier","text":"PersonNameComponents"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","abstract":[{"text":"Authenticates a user with their Sign In with Apple authorization code.","type":"text"}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m":{"url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m","kind":"symbol","abstract":[{"text":"Authenticates a user with their Sign In with Apple authorization code.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#token-exchange-for-native-social":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","url":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(email:code:audience:scope:)-39g8b.json b/docs/data/documentation/auth0/authentication/login(email:code:audience:scope:)-39g8b.json index cc7fec28..58a7816b 100644 --- a/docs/data/documentation/auth0/authentication/login(email:code:audience:scope:)-39g8b.json +++ b/docs/data/documentation/auth0/authentication/login(email:code:audience:scope:)-39g8b.json @@ -1 +1 @@ -{"metadata":{"title":"login(email:code:audience:scope:)","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","externalID":"s:5Auth014AuthenticationPAAE5login5email4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}]},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"flow."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" = defaultScope) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"email","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Email the user used to start the passwordless login flow."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"One-time password (OTP) code the user received via email."}]}],"name":"code"},{"content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"audience"},{"content":[{"inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"scope"}]},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"Request that will yield Auth0 user’s credentials.","type":"text"}]}]},{"content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\", code: \"123456\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp","type":"codeVoice"},{"text":". Check","type":"text"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true},{"type":"text","text":" for more information."}]}],"type":"aside","name":"Requires"}],"kind":"content"}],"sections":[],"references":{"https://auth0.com/docs/api/authentication#authenticate-user":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"title":"Error Responses","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","titleInlineContent":[{"text":"Error Responses","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-39g8b":{"role":"symbol","kind":"symbol","abstract":[{"text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"flow."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"login(email:code:audience:scope:)"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","titleInlineContent":[{"text":"our documentation","type":"text"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-587bo":{"abstract":[{"text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login","type":"text"},{"type":"text","text":" "},{"text":"flow.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","title":"login(email:code:audience:scope:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","defaultImplementations":1},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" = defaultScope) -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Email the user used to start the passwordless login flow.","type":"text"}],"type":"paragraph"}],"name":"email"},{"name":"code","content":[{"inlineContent":[{"text":"One-time password (OTP) code the user received via email.","type":"text"}],"type":"paragraph"}]},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"text":"API Identifier that your application is requesting access to. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"scope"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"text":"Usage","anchor":"Usage","level":2,"type":"heading"},{"code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\", code: \"123456\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift","type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"content":[{"inlineContent":[{"text":"Passwordless OTP Grant ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"type":"text","text":". Check"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true},{"type":"text","text":" for more information."}],"type":"paragraph"}],"name":"Requires","type":"aside","style":"note"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b"},"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","abstract":[{"type":"text","text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login"},{"text":" ","type":"text"},{"type":"text","text":"flow."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo"]]},"metadata":{"extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"method","title":"login(email:code:audience:scope:)","externalID":"s:5Auth014AuthenticationPAAE5login5email4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","roleHeading":"Instance Method"},"references":{"https://auth0.com/docs/api/authentication#authenticate-user":{"title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","type":"link"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"titleInlineContent":[{"type":"text","text":"our documentation"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"titleInlineContent":[{"type":"text","text":"Error Responses"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","title":"Error Responses"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-587bo":{"role":"symbol","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","title":"login(email:code:audience:scope:)","kind":"symbol","type":"topic","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","abstract":[{"type":"text","text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login"},{"type":"text","text":" "},{"type":"text","text":"flow."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-39g8b":{"abstract":[{"type":"text","text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login"},{"text":" ","type":"text"},{"text":"flow.","type":"text"}],"title":"login(email:code:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","type":"topic","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(email:code:audience:scope:)-587bo.json b/docs/data/documentation/auth0/authentication/login(email:code:audience:scope:)-587bo.json index 0d6ca4ee..9c9d7c6e 100644 --- a/docs/data/documentation/auth0/authentication/login(email:code:audience:scope:)-587bo.json +++ b/docs/data/documentation/auth0/authentication/login(email:code:audience:scope:)-587bo.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","interfaceLanguage":"swift"},"sections":[],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b"],"title":"Authentication Implementations"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Email the user used to start the passwordless login flow."}]}],"name":"email"},{"content":[{"inlineContent":[{"text":"One-time password (OTP) code the user received via email.","type":"text"}],"type":"paragraph"}],"name":"code"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]}],"name":"audience"},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"text":".","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"Request that will yield Auth0 user’s credentials.","type":"text"}]}]},{"content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\", code: \"123456\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"text":". Check","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true},{"type":"text","text":" for more information."}],"type":"paragraph"}],"style":"note","name":"Requires"}],"kind":"content"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","abstract":[{"text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login","type":"text"},{"type":"text","text":" "},{"type":"text","text":"flow."}],"metadata":{"roleHeading":"Instance Method","role":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"symbolKind":"method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP5login5email4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","title":"login(email:code:audience:scope:)"},"references":{"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"title":"Error Responses","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","type":"link","titleInlineContent":[{"text":"Error Responses","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation","titleInlineContent":[{"text":"our documentation","type":"text"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link"},"https://auth0.com/docs/api/authentication":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-39g8b":{"role":"symbol","kind":"symbol","abstract":[{"text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"flow."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"login(email:code:audience:scope:)"},"https://auth0.com/docs/api/authentication#authenticate-user":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-587bo":{"abstract":[{"text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login","type":"text"},{"type":"text","text":" "},{"text":"flow.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","title":"login(email:code:audience:scope:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","defaultImplementations":1}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"method","role":"symbol","modules":[{"name":"Auth0"}],"required":true,"title":"login(email:code:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP5login5email4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Email the user used to start the passwordless login flow."}],"type":"paragraph"}],"name":"email"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"One-time password (OTP) code the user received via email."}]}],"name":"code"},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}]}]},{"content":[{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\", code: \"123456\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}]},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Passwordless OTP Grant ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"type":"text","text":". Check"},{"text":" ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"type":"text","text":" for more information."}]}],"type":"aside","name":"Requires","style":"note"}],"kind":"content"}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b"],"title":"Authentication Implementations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"type":"text","text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login"},{"type":"text","text":" "},{"type":"text","text":"flow."}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"],"title":"Related Documentation"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-587bo":{"role":"symbol","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-587bo","title":"login(email:code:audience:scope:)","kind":"symbol","type":"topic","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","abstract":[{"type":"text","text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login"},{"type":"text","text":" "},{"type":"text","text":"flow."}]},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"title":"Error Responses","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","type":"link","titleInlineContent":[{"type":"text","text":"Error Responses"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/api/authentication#authenticate-user":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","url":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","type":"link"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}],"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","title":"our documentation"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-39g8b":{"abstract":[{"type":"text","text":"Logs in a user using an email and an OTP code received via email. This is the last part of the passwordless login"},{"text":" ","type":"text"},{"text":"flow.","type":"text"}],"title":"login(email:code:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","type":"topic","url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj.json b/docs/data/documentation/auth0/authentication/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj.json index 9fe34b1d..23e5a8d1 100644 --- a/docs/data/documentation/auth0/authentication/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj.json +++ b/docs/data/documentation/auth0/authentication/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj.json @@ -1 +1 @@ -{"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"abstract":[{"type":"text","text":"Authenticates a user with their Facebook "},{"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","isActive":true,"type":"reference"},{"type":"text","text":" and profile data."}],"metadata":{"externalID":"s:5Auth014AuthenticationPAAE5login26facebookSessionAccessToken7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SDySSypGSSSgSStF","title":"login(facebookSessionAccessToken:profile:audience:scope:)","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","role":"symbol","extendedModule":"Auth0","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"sessionAccessToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"profile"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" = defaultScope) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"sessionAccessToken","content":[{"type":"paragraph","inlineContent":[{"text":"Session info access token retrieved from Facebook.","type":"text"}]}]},{"name":"profile","content":[{"inlineContent":[{"text":"The user profile data retrieved from Facebook.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}]}],"name":"audience"},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}]},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(facebookSessionAccessToken: \"session-info-access-token\","," profile: [\"key\": \"value\"])"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"code":["Auth0"," .authentication()"," .login(facebookSessionAccessToken: \"session-info-access-token\","," profile: [\"key\": \"value\"],"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"syntax":"swift","type":"codeListing"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"login(facebookSessionAccessToken:profile:audience:scope:)","abstract":[{"text":"Authenticates a user with their Facebook ","type":"text"},{"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","isActive":true,"type":"reference"},{"text":" and profile data.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g","type":"topic","defaultImplementations":1,"required":true},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"title":"session info access token","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","titleInlineContent":[{"type":"text","text":"session info access token"}],"url":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj":{"type":"topic","title":"login(facebookSessionAccessToken:profile:audience:scope:)","role":"symbol","abstract":[{"type":"text","text":"Authenticates a user with their Facebook "},{"isActive":true,"type":"reference","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"},{"type":"text","text":" and profile data."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"https://auth0.com/docs/api/authentication#token-exchange-for-native-social":{"type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Authenticates a user with their Facebook "},{"type":"reference","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","isActive":true},{"type":"text","text":" and profile data."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"sessionAccessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" = defaultScope) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Session info access token retrieved from Facebook.","type":"text"}]}],"name":"sessionAccessToken"},{"content":[{"inlineContent":[{"type":"text","text":"The user profile data retrieved from Facebook."}],"type":"paragraph"}],"name":"profile"},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"name":"audience"},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}]},{"kind":"content","content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"code":["Auth0"," .authentication()"," .login(facebookSessionAccessToken: \"session-info-access-token\","," profile: [\"key\": \"value\"])"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"type":"paragraph"},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(facebookSessionAccessToken: \"session-info-access-token\","," profile: [\"key\": \"value\"],"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"syntax":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj"]}],"metadata":{"role":"symbol","symbolKind":"method","extendedModule":"Auth0","title":"login(facebookSessionAccessToken:profile:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationPAAE5login26facebookSessionAccessToken7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SDySSypGSSSgSStF","roleHeading":"Instance Method"},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g":{"abstract":[{"type":"text","text":"Authenticates a user with their Facebook "},{"type":"reference","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","isActive":true},{"type":"text","text":" and profile data."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"title":"login(facebookSessionAccessToken:profile:audience:scope:)","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","kind":"symbol","role":"symbol","required":true,"type":"topic","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#token-exchange-for-native-social":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","type":"link","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj":{"abstract":[{"text":"Authenticates a user with their Facebook ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"},{"type":"text","text":" and profile data."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"login(facebookSessionAccessToken:profile:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"titleInlineContent":[{"type":"text","text":"session info access token"}],"type":"link","title":"session info access token","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","url":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g.json b/docs/data/documentation/auth0/authentication/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g.json index a6e28011..96367a51 100644 --- a/docs/data/documentation/auth0/authentication/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g.json +++ b/docs/data/documentation/auth0/authentication/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g.json @@ -1 +1 @@ -{"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"]}],"abstract":[{"text":"Authenticates a user with their Facebook ","type":"text"},{"type":"reference","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","isActive":true},{"text":" and profile data.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":" "},{"text":"sessionAccessToken","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"sessionAccessToken","content":[{"type":"paragraph","inlineContent":[{"text":"Session info access token retrieved from Facebook.","type":"text"}]}]},{"content":[{"inlineContent":[{"text":"The user profile data retrieved from Facebook.","type":"text"}],"type":"paragraph"}],"name":"profile"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}]}],"name":"audience"},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .login(facebookSessionAccessToken: \"session-info-access-token\","," profile: [\"key\": \"value\"])"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(facebookSessionAccessToken: \"session-info-access-token\","," profile: [\"key\": \"value\"],"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","interfaceLanguage":"swift"},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj"],"title":"Authentication Implementations"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"modules":[{"name":"Auth0"}],"title":"login(facebookSessionAccessToken:profile:audience:scope:)","symbolKind":"method","role":"symbol","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP5login26facebookSessionAccessToken7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SDySSypGSSSgSStF"},"references":{"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj":{"type":"topic","title":"login(facebookSessionAccessToken:profile:audience:scope:)","role":"symbol","abstract":[{"type":"text","text":"Authenticates a user with their Facebook "},{"isActive":true,"type":"reference","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"},{"type":"text","text":" and profile data."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"login(facebookSessionAccessToken:profile:audience:scope:)","abstract":[{"text":"Authenticates a user with their Facebook ","type":"text"},{"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","isActive":true,"type":"reference"},{"text":" and profile data.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g","type":"topic","defaultImplementations":1,"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"https://auth0.com/docs/api/authentication#token-exchange-for-native-social":{"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","type":"link","title":"session info access token","titleInlineContent":[{"type":"text","text":"session info access token"}],"url":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"symbolKind":"method","title":"login(facebookSessionAccessToken:profile:audience:scope:)","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"profile"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationP5login26facebookSessionAccessToken7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SDySSypGSSSgSStF","role":"symbol"},"abstract":[{"type":"text","text":"Authenticates a user with their Facebook "},{"type":"reference","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","isActive":true},{"text":" and profile data.","type":"text"}],"sections":[],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj"],"title":"Authentication Implementations"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"sessionAccessToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"sessionAccessToken","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Session info access token retrieved from Facebook."}]}]},{"name":"profile","content":[{"inlineContent":[{"type":"text","text":"The user profile data retrieved from Facebook."}],"type":"paragraph"}]},{"name":"audience","content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}],"type":"paragraph"}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}],"kind":"content"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"code":["Auth0"," .authentication()"," .login(facebookSessionAccessToken: \"session-info-access-token\","," profile: [\"key\": \"value\"])"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"code":["Auth0"," .authentication()"," .login(facebookSessionAccessToken: \"session-info-access-token\","," profile: [\"key\": \"value\"],"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social"]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g":{"abstract":[{"type":"text","text":"Authenticates a user with their Facebook "},{"type":"reference","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","isActive":true},{"type":"text","text":" and profile data."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"title":"login(facebookSessionAccessToken:profile:audience:scope:)","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-8wh5g","kind":"symbol","role":"symbol","required":true,"type":"topic","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"url":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","titleInlineContent":[{"type":"text","text":"session info access token"}],"type":"link","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","title":"session info access token"},"https://auth0.com/docs/api/authentication#token-exchange-for-native-social":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#token-exchange-for-native-social","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj":{"abstract":[{"text":"Authenticates a user with their Facebook ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"},{"type":"text","text":" and profile data."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"login(facebookSessionAccessToken:profile:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(phonenumber:code:audience:scope:)-38nv0.json b/docs/data/documentation/auth0/authentication/login(phonenumber:code:audience:scope:)-38nv0.json index c790f7a2..97353d0a 100644 --- a/docs/data/documentation/auth0/authentication/login(phonenumber:code:audience:scope:)-38nv0.json +++ b/docs/data/documentation/auth0/authentication/login(phonenumber:code:audience:scope:)-38nv0.json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"metadata":{"externalID":"s:5Auth014AuthenticationP5login11phoneNumber4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"role":"symbol","title":"login(phoneNumber:code:audience:scope:)","required":true,"symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"phoneNumber","content":[{"inlineContent":[{"text":"Phone number the user used to start the passwordless login flow.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"One-time password (OTP) code the user received via SMS."}],"type":"paragraph"}],"name":"code"},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"text":".","type":"text"}]}],"name":"scope"}]},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}]}],"kind":"content"},{"content":[{"text":"Usage","anchor":"Usage","level":2,"type":"heading"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(phoneNumber: \"+12025550135\", code: \"123456\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(phoneNumber: \"+12025550135\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"type":"text","text":". Check"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true},{"type":"text","text":" for more information."}]}],"name":"Requires","style":"note","type":"aside"}],"kind":"content"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii"]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-8kbii":{"title":"login(phoneNumber:code:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","type":"topic","kind":"symbol"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"type":"link","title":"our documentation","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-38nv0":{"required":true,"title":"login(phoneNumber:code:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","defaultImplementations":1,"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/api/authentication#authenticate-user":{"type":"link","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"titleInlineContent":[{"type":"text","text":"Error Responses"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","title":"Error Responses"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow.","type":"text"}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"phoneNumber","content":[{"inlineContent":[{"text":"Phone number the user used to start the passwordless login flow.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"One-time password (OTP) code the user received via SMS."}]}],"name":"code"},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"text":"API Identifier that your application is requesting access to. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"scope"}]},{"kind":"content","content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"code":["Auth0"," .authentication()"," .login(phoneNumber: \"+12025550135\", code: \"123456\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift","type":"codeListing"},{"type":"paragraph","inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .login(phoneNumber: \"+12025550135\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]},{"content":[{"inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp","type":"codeVoice"},{"type":"text","text":". Check"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true},{"type":"text","text":" for more information."}],"type":"paragraph"}],"style":"note","name":"Requires","type":"aside"}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0"},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"title":"login(phoneNumber:code:audience:scope:)","role":"symbol","required":true,"externalID":"s:5Auth014AuthenticationP5login11phoneNumber4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"symbolKind":"method"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"],"title":"Related Documentation"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-8kbii":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","title":"login(phoneNumber:code:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii","role":"symbol","abstract":[{"type":"text","text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-38nv0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","title":"login(phoneNumber:code:audience:scope:)","abstract":[{"type":"text","text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"https://auth0.com/docs/api/authentication#authenticate-user":{"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user"},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"titleInlineContent":[{"text":"Error Responses","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","title":"Error Responses","type":"link"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"title":"our documentation","type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"text":"our documentation","type":"text"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(phonenumber:code:audience:scope:)-8kbii.json b/docs/data/documentation/auth0/authentication/login(phonenumber:code:audience:scope:)-8kbii.json index 4c788846..8feee5cc 100644 --- a/docs/data/documentation/auth0/authentication/login(phonenumber:code:audience:scope:)-8kbii.json +++ b/docs/data/documentation/auth0/authentication/login(phonenumber:code:audience:scope:)-8kbii.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii"},"kind":"symbol","seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"],"title":"Related Documentation"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0"]]},"metadata":{"role":"symbol","extendedModule":"Auth0","externalID":"s:5Auth014AuthenticationPAAE5login11phoneNumber4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"symbolKind":"method","title":"login(phoneNumber:code:audience:scope:)","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method"},"sections":[],"abstract":[{"text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"phoneNumber","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" = defaultScope) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Phone number the user used to start the passwordless login flow."}]}],"name":"phoneNumber"},{"name":"code","content":[{"inlineContent":[{"type":"text","text":"One-time password (OTP) code the user received via SMS."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"API Identifier that your application is requesting access to. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"audience"},{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"scope"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"inlineContent":[{"text":"Request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"anchor":"Usage","text":"Usage","type":"heading","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(phoneNumber: \"+12025550135\", code: \"123456\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(phoneNumber: \"+12025550135\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"syntax":"swift"},{"content":[{"inlineContent":[{"text":"Passwordless OTP Grant ","type":"text"},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp","type":"codeVoice"},{"text":". Check","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"reference","isActive":true},{"type":"text","text":" for more information."}],"type":"paragraph"}],"type":"aside","style":"note","name":"Requires"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"type":"link","title":"our documentation","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-8kbii":{"title":"login(phoneNumber:code:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-38nv0":{"required":true,"title":"login(phoneNumber:code:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","defaultImplementations":1,"type":"topic","kind":"symbol"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"type":"link","title":"Error Responses","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","titleInlineContent":[{"type":"text","text":"Error Responses"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/api/authentication#authenticate-user":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" = defaultScope) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"name":"phoneNumber","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Phone number the user used to start the passwordless login flow."}]}]},{"name":"code","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"One-time password (OTP) code the user received via SMS."}]}]},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to. Defaults to "},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"text":".","type":"text"}]}],"name":"scope"}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"inlineContent":[{"text":"Request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}]},{"content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .login(phoneNumber: \"+12025550135\", code: \"123456\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"code":["Auth0"," .authentication()"," .login(phoneNumber: \"+12025550135\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"syntax":"swift","type":"codeListing"},{"style":"note","name":"Requires","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"type":"text","text":". Check"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}]}]}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"symbolKind":"method","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"title":"login(phoneNumber:code:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationPAAE5login11phoneNumber4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0"]]},"sections":[],"abstract":[{"text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow.","type":"text"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-8kbii":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","title":"login(phoneNumber:code:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii","role":"symbol","abstract":[{"type":"text","text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"kind":"symbol"},"https://auth0.com/docs/api/authentication#authenticate-user":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","url":"https:\/\/auth0.com\/docs\/api\/authentication#authenticate-user","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#post-passwordless-verify":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify","titleInlineContent":[{"type":"text","text":"Error Responses"}],"title":"Error Responses","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-verify"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"text":"our documentation","type":"text"}],"type":"link","title":"our documentation"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-38nv0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-38nv0","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","title":"login(phoneNumber:code:audience:scope:)","abstract":[{"type":"text","text":"Logs in a user using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"required":true,"role":"symbol","defaultImplementations":1}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w.json b/docs/data/documentation/auth0/authentication/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w.json index aa844a65..0da31133 100644 --- a/docs/data/documentation/auth0/authentication/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w.json +++ b/docs/data/documentation/auth0/authentication/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w.json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"usernameOrEmail","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"username"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":" "},{"kind":"internalParam","text":"realm"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Username or email of the user.","type":"text"}],"type":"paragraph"}],"name":"usernameOrEmail"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Password of the user."}]}],"name":"password"},{"name":"realmOrConnection","content":[{"inlineContent":[{"text":"Domain of the realm or connection name.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}]}],"name":"audience"},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"Request that will yield Auth0 user’s credentials.","type":"text"}]}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Usage","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .login(usernameOrEmail: \"support@auth0.com\","," password: \"secret-password\","," realmOrConnection: \"MyDatabase\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}]},{"code":["Auth0"," .authentication()"," .login(usernameOrEmail: \"support@auth0.com\","," password: \"secret-password\","," realmOrConnection: \"MyDatabase\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"style":"note","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/password-realm"},{"type":"text","text":" grant. Check"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}],"type":"paragraph"}],"name":"Requires","type":"aside"}]}],"metadata":{"role":"symbol","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","required":true,"externalID":"s:5Auth014AuthenticationP5login15usernameOrEmail8password05realmE10Connection8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S3SSgSStF","symbolKind":"method"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w":{"abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","required":true,"type":"topic","role":"symbol","defaultImplementations":1,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"realmOrConnection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","kind":"symbol"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation","titleInlineContent":[{"type":"text","text":"our documentation"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq":{"abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"realmOrConnection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"}}} \ No newline at end of file +{"sections":[],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq"]}],"abstract":[{"text":"Logs in a user using a username and password with a realm or connection.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"usernameOrEmail","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"username"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":" "},{"kind":"internalParam","text":"realm"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"usernameOrEmail","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Username or email of the user."}]}]},{"name":"password","content":[{"type":"paragraph","inlineContent":[{"text":"Password of the user.","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Domain of the realm or connection name."}],"type":"paragraph"}],"name":"realmOrConnection"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}]}],"name":"audience"},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested scope values.","type":"text"}]}]}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(usernameOrEmail: \"support@auth0.com\","," password: \"secret-password\","," realmOrConnection: \"MyDatabase\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"code":["Auth0"," .authentication()"," .login(usernameOrEmail: \"support@auth0.com\","," password: \"secret-password\","," realmOrConnection: \"MyDatabase\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"name":"Requires","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/password-realm"},{"type":"text","text":" grant. Check"},{"type":"text","text":" "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"reference"},{"type":"text","text":" for more information."}]}]}]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"required":true,"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"usernameOrEmail"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"realmOrConnection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationP5login15usernameOrEmail8password05realmE10Connection8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S3SSgSStF","roleHeading":"Instance Method","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","role":"symbol","defaultImplementations":1,"abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","kind":"symbol","type":"topic","required":true},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation","titleInlineContent":[{"type":"text","text":"our documentation"}],"type":"link","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","role":"symbol","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq.json b/docs/data/documentation/auth0/authentication/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq.json index 800f1dbf..ed73c3a2 100644 --- a/docs/data/documentation/auth0/authentication/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq.json +++ b/docs/data/documentation/auth0/authentication/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq.json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w"]]},"metadata":{"role":"symbol","externalID":"s:5Auth014AuthenticationPAAE5login15usernameOrEmail8password05realmE10Connection8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S3SSgSStF","symbolKind":"method","extendedModule":"Auth0","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"usernameOrEmail","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"username"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"realmOrConnection","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"realm"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" = defaultScope) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Username or email of the user."}]}],"name":"usernameOrEmail"},{"name":"password","content":[{"type":"paragraph","inlineContent":[{"text":"Password of the user.","type":"text"}]}]},{"name":"realmOrConnection","content":[{"inlineContent":[{"text":"Domain of the realm or connection name.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}]}],"name":"audience"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values."}]}],"name":"scope"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}]}],"kind":"content"},{"kind":"content","content":[{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(usernameOrEmail: \"support@auth0.com\","," password: \"secret-password\","," realmOrConnection: \"MyDatabase\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"type":"paragraph"},{"code":["Auth0"," .authentication()"," .login(usernameOrEmail: \"support@auth0.com\","," password: \"secret-password\","," realmOrConnection: \"MyDatabase\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"style":"note","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/password-realm"},{"type":"text","text":" grant. Check"},{"text":" ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}]}],"type":"aside"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}],"title":"our documentation","type":"link","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"title":"Auth0 Authentication API","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w":{"abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","required":true,"type":"topic","role":"symbol","defaultImplementations":1,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"realmOrConnection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq":{"abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"realmOrConnection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"}}} \ No newline at end of file +{"sections":[],"abstract":[{"text":"Logs in a user using a username and password with a realm or connection.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"realmOrConnection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","extendedModule":"Auth0","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","externalID":"s:5Auth014AuthenticationPAAE5login15usernameOrEmail8password05realmE10Connection8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S3SSgSStF"},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"usernameOrEmail"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"username"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"realm","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" = defaultScope) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Username or email of the user.","type":"text"}],"type":"paragraph"}],"name":"usernameOrEmail"},{"name":"password","content":[{"inlineContent":[{"type":"text","text":"Password of the user."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Domain of the realm or connection name."}],"type":"paragraph"}],"name":"realmOrConnection"},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"name":"audience"},{"name":"scope","content":[{"inlineContent":[{"text":"Space-separated list of requested scope values.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(usernameOrEmail: \"support@auth0.com\","," password: \"secret-password\","," realmOrConnection: \"MyDatabase\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(usernameOrEmail: \"support@auth0.com\","," password: \"secret-password\","," realmOrConnection: \"MyDatabase\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]},{"type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/password-realm","type":"codeVoice"},{"type":"text","text":" grant. Check"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"type":"text","text":" for more information."}]}],"name":"Requires"}],"kind":"content"}],"references":{"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"title":"our documentation","titleInlineContent":[{"type":"text","text":"our documentation"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-5yc0w","role":"symbol","defaultImplementations":1,"abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","kind":"symbol","type":"topic","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","role":"symbol","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","abstract":[{"type":"text","text":"Logs in a user using a username and password with a realm or connection."}],"url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(withoobcode:mfatoken:bindingcode:)-3r1t9.json b/docs/data/documentation/auth0/authentication/login(withoobcode:mfatoken:bindingcode:)-3r1t9.json index c9b3628d..59a4c7ae 100644 --- a/docs/data/documentation/auth0/authentication/login(withoobcode:mfatoken:bindingcode:)-3r1t9.json +++ b/docs/data/documentation/auth0/authentication/login(withoobcode:mfatoken:bindingcode:)-3r1t9.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"],"title":"Authentication Implementations"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOOBCode"},{"text":" ","kind":"text"},{"text":"oobCode","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The OOB code received from the challenge request.","type":"text"}]}],"name":"oobCode"},{"name":"mfaToken","content":[{"inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},{"text":" error due to MFA requirement.","type":"text"}],"type":"paragraph"}]},{"name":"bindingCode","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A code used to bind the side channel (used to deliver the challenge) with the main channel you are using to authenticate. This is usually an OTP-like code delivered as part of the challenge message."}]}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}]},{"content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .login(withOOBCode: \"123456\", mfaToken: \"mfa-token\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-oob"},{"type":"text","text":" grant. Check"},{"text":" ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}]}],"style":"note","name":"Requires"}],"kind":"content"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-"],"title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9"]}],"metadata":{"role":"symbol","externalID":"s:5Auth014AuthenticationP5login11withOOBCode8mfaToken11bindingCodeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgtF","symbolKind":"method","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"title":"login(withOOBCode:mfaToken:bindingCode:)","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method"},"kind":"symbol","sections":[],"abstract":[{"text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS","type":"text"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3r1t9":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"defaultImplementations":1,"title":"login(withOOBCode:mfaToken:bindingCode:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3ykhg":{"url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"title":"login(withOOBCode:mfaToken:bindingCode:)","kind":"symbol","role":"symbol","type":"topic"},"https://auth0.com/docs/api/authentication#verify-with-out-of-band-oob-":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"https://auth0.com/docs/api/authentication":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","titleInlineContent":[{"type":"text","text":"our documentation"}],"title":"our documentation","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withOOBCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","title":"login(withOOBCode:mfaToken:bindingCode:)","externalID":"s:5Auth014AuthenticationP5login11withOOBCode8mfaToken11bindingCodeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgtF","role":"symbol"},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-"]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"text":" ","type":"text"},{"text":"or voice).","type":"text"}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"oobCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The OOB code received from the challenge request.","type":"text"}]}],"name":"oobCode"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"reference","isActive":true},{"type":"text","text":" error due to MFA requirement."}]}],"name":"mfaToken"},{"content":[{"type":"paragraph","inlineContent":[{"text":"A code used to bind the side channel (used to deliver the challenge) with the main channel you are using to authenticate. This is usually an OTP-like code delivered as part of the challenge message.","type":"text"}]}],"name":"bindingCode"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}]},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(withOOBCode: \"123456\", mfaToken: \"mfa-token\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"},{"content":[{"inlineContent":[{"type":"text","text":"The "},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-oob","type":"codeVoice"},{"type":"text","text":" grant. Check"},{"text":" ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"type":"text","text":" for more information."}],"type":"paragraph"}],"type":"aside","style":"note","name":"Requires"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isMultifactorRequired","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}],"type":"link","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/api/authentication#verify-with-out-of-band-oob-":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-","type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3ykhg":{"title":"login(withOOBCode:mfaToken:bindingCode:)","abstract":[{"text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS","type":"text"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3r1t9":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","title":"login(withOOBCode:mfaToken:bindingCode:)","abstract":[{"text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"or voice)."}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(withoobcode:mfatoken:bindingcode:)-3ykhg.json b/docs/data/documentation/auth0/authentication/login(withoobcode:mfatoken:bindingcode:)-3ykhg.json index f946a541..6bb6edf3 100644 --- a/docs/data/documentation/auth0/authentication/login(withoobcode:mfatoken:bindingcode:)-3ykhg.json +++ b/docs/data/documentation/auth0/authentication/login(withoobcode:mfatoken:bindingcode:)-3ykhg.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-"]}],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"oobCode"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The OOB code received from the challenge request."}]}],"name":"oobCode"},{"name":"mfaToken","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"reference"},{"text":" error due to MFA requirement.","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"A code used to bind the side channel (used to deliver the challenge) with the main channel you are using to authenticate. This is usually an OTP-like code delivered as part of the challenge message."}],"type":"paragraph"}],"name":"bindingCode"}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}]},{"content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(withOOBCode: \"123456\", mfaToken: \"mfa-token\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"name":"Requires","type":"aside","style":"note","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-oob"},{"type":"text","text":" grant. Check"},{"type":"text","text":" "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"reference"},{"text":" for more information.","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationPAAE5login11withOOBCode8mfaToken11bindingCodeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgtF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"login(withOOBCode:mfaToken:bindingCode:)","extendedModule":"Auth0"},"abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"https://auth0.com/docs/get-started/applications/application-grant-types":{"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}],"title":"our documentation","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3r1t9":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"defaultImplementations":1,"title":"login(withOOBCode:mfaToken:bindingCode:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3ykhg":{"url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"title":"login(withOOBCode:mfaToken:bindingCode:)","kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"isMultifactorRequired"},"https://auth0.com/docs/api/authentication#verify-with-out-of-band-oob-":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationPAAE5login11withOOBCode8mfaToken11bindingCodeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgtF","title":"login(withOOBCode:mfaToken:bindingCode:)","roleHeading":"Instance Method","extendedModule":"Auth0"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9"]]},"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-"],"title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"oobCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil) -> "},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"oobCode","content":[{"type":"paragraph","inlineContent":[{"text":"The OOB code received from the challenge request.","type":"text"}]}]},{"name":"mfaToken","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","isActive":true},{"text":" error due to MFA requirement.","type":"text"}]}]},{"name":"bindingCode","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A code used to bind the side channel (used to deliver the challenge) with the main channel you are using to authenticate. This is usually an OTP-like code delivered as part of the challenge message."}]}]}]},{"content":[{"text":"Return Value","anchor":"return-value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}],"kind":"content"},{"kind":"content","content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(withOOBCode: \"123456\", mfaToken: \"mfa-token\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"style":"note","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-oob"},{"text":" grant. Check","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true},{"text":" for more information.","type":"text"}]}],"type":"aside"}]}],"kind":"symbol","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"text":"or voice).","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3r1t9":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3r1t9","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","title":"login(withOOBCode:mfaToken:bindingCode:)","abstract":[{"text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"or voice)."}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3ykhg":{"title":"login(withOOBCode:mfaToken:bindingCode:)","abstract":[{"text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS","type":"text"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isMultifactorRequired","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"type":"link","title":"our documentation","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#verify-with-out-of-band-oob-":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-out-of-band-oob-","title":"Authentication API Endpoint"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(withotp:mfatoken:).json b/docs/data/documentation/auth0/authentication/login(withotp:mfatoken:).json index 586e89d2..1594a6c1 100644 --- a/docs/data/documentation/auth0/authentication/login(withotp:mfatoken:).json +++ b/docs/data/documentation/auth0/authentication/login(withotp:mfatoken:).json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","metadata":{"title":"login(withOTP:mfaToken:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP5login7withOTP8mfaTokenAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SStF","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"withOTP","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","role":"symbol","required":true},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withOTP"},{"kind":"text","text":" "},{"text":"otp","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"One-time password supplied by a MFA authenticator."}],"type":"paragraph"}],"name":"otp"},{"name":"mfaToken","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"reference"},{"text":" error due to MFA requirement.","type":"text"}]}]}]},{"content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(withOTP: \"123456\", mfaToken: \"mfa-token\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"},{"name":"Requires","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The "},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-otp","type":"codeVoice"},{"type":"text","text":" grant. Check"},{"text":" ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"type":"text","text":" for more information."}],"type":"paragraph"}],"style":"note"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#verify-with-one-time-password-otp-"]}],"sections":[],"abstract":[{"text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP).","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"https://auth0.com/docs/api/authentication#verify-with-one-time-password-otp-":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-one-time-password-otp-","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-one-time-password-otp-","title":"Authentication API Endpoint","type":"link"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"titleInlineContent":[{"text":"our documentation","type":"text"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation","type":"link"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOTP:mfaToken:)":{"abstract":[{"text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP).","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","title":"login(withOTP:mfaToken:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withOTP"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"metadata":{"required":true,"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOTP"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationP5login7withOTP8mfaTokenAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SStF","title":"login(withOTP:mfaToken:)","roleHeading":"Instance Method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#verify-with-one-time-password-otp-"]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"withOTP","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"otp","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"otp","content":[{"type":"paragraph","inlineContent":[{"text":"One-time password supplied by a MFA authenticator.","type":"text"}]}]},{"content":[{"inlineContent":[{"text":"Token returned when authentication fails with an ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},{"type":"text","text":" error due to MFA requirement."}],"type":"paragraph"}],"name":"mfaToken"}]},{"content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"code":["Auth0"," .authentication()"," .login(withOTP: \"123456\", mfaToken: \"mfa-token\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-otp"},{"text":" grant. Check","type":"text"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true,"type":"reference"},{"type":"text","text":" for more information."}]}],"type":"aside","style":"note","name":"Requires"}]}],"kind":"symbol","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP)."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOTP:mfaToken:)":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"withOTP","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","title":"login(withOTP:mfaToken:)","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP)."}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isMultifactorRequired","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#verify-with-one-time-password-otp-":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-one-time-password-otp-","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-one-time-password-otp-"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","title":"our documentation","titleInlineContent":[{"text":"our documentation","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(withrecoverycode:mfatoken:).json b/docs/data/documentation/auth0/authentication/login(withrecoverycode:mfatoken:).json index 483ed2ff..31dbf363 100644 --- a/docs/data/documentation/auth0/authentication/login(withrecoverycode:mfatoken:).json +++ b/docs/data/documentation/auth0/authentication/login(withrecoverycode:mfatoken:).json @@ -1 +1 @@ -{"abstract":[{"text":"Verifies multi-factor authentication (MFA) using a recovery code.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to"},{"type":"text","text":" "},{"type":"text","text":"authenticate when the user’s enrolled device is unavailable, or the user cannot receive the challenge or accept"},{"text":" ","type":"text"},{"text":"it due to connectivity issues.","type":"text"}],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","https:\/\/auth0.com\/docs\/api\/authentication#verify-with-recovery-code"],"title":"Related Documentation"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRecoveryCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"title":"login(withRecoveryCode:mfaToken:)","role":"symbol","modules":[{"name":"Auth0"}],"required":true,"roleHeading":"Instance Method","symbolKind":"method","externalID":"s:5Auth014AuthenticationP5login16withRecoveryCode8mfaTokenAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SStF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","interfaceLanguage":"swift"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRecoveryCode","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"name":"recoveryCode","content":[{"type":"paragraph","inlineContent":[{"text":"Recovery code provided by the user.","type":"text"}]}]},{"name":"mfaToken","content":[{"inlineContent":[{"text":"Token returned when authentication fails with an ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","isActive":true},{"text":" error due to MFA requirement.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials. Might include a "},{"inlineContent":[{"type":"text","text":"recovery code"}],"type":"strong"},{"text":", which the","type":"text"},{"type":"text","text":" "},{"type":"text","text":"application must display to the user to be stored securely for future use."}]}]},{"kind":"content","content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"code":["Auth0"," .authentication()"," .login(withRecoveryCode: \"recovery-code\", mfaToken: \"mfa-token\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift","type":"codeListing"},{"content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-recovery-code","type":"codeVoice"},{"text":" grant. Check","type":"text"},{"text":" ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}]}],"style":"note","name":"Requires","type":"aside"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withRecoveryCode:mfaToken:)":{"abstract":[{"text":"Verifies multi-factor authentication (MFA) using a recovery code.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to"},{"text":" ","type":"text"},{"text":"authenticate when the user’s enrolled device is unavailable, or the user cannot receive the challenge or accept","type":"text"},{"text":" ","type":"text"},{"text":"it due to connectivity issues.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","title":"login(withRecoveryCode:mfaToken:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"text":"withRecoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation","type":"link","titleInlineContent":[{"type":"text","text":"our documentation"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"abstract":[{"text":"MFA recovery code that the application must display to the user, to be stored securely for future use.","type":"text"}],"url":"\/documentation\/auth0\/credentials\/recoverycode","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","title":"recoveryCode"},"https://auth0.com/docs/api/authentication#verify-with-recovery-code":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-recovery-code","title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-recovery-code"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","https:\/\/auth0.com\/docs\/api\/authentication#verify-with-recovery-code"],"title":"Related Documentation"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withRecoveryCode","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"recoveryCode","content":[{"inlineContent":[{"type":"text","text":"Recovery code provided by the user."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","isActive":true},{"type":"text","text":" error due to MFA requirement."}]}],"name":"mfaToken"}],"kind":"parameters"},{"content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials. Might include a "},{"type":"strong","inlineContent":[{"text":"recovery code","type":"text"}]},{"type":"text","text":", which the"},{"text":" ","type":"text"},{"type":"text","text":"application must display to the user to be stored securely for future use."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(withRecoveryCode: \"recovery-code\", mfaToken: \"mfa-token\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"aside","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The "},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-recovery-code","type":"codeVoice"},{"text":" grant. Check","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"reference"},{"type":"text","text":" for more information."}],"type":"paragraph"}],"style":"note"}]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"externalID":"s:5Auth014AuthenticationP5login16withRecoveryCode8mfaTokenAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SStF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRecoveryCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"required":true,"modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Method","symbolKind":"method","title":"login(withRecoveryCode:mfaToken:)"},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"Verifies multi-factor authentication (MFA) using a recovery code.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to"},{"type":"text","text":" "},{"text":"authenticate when the user’s enrolled device is unavailable, or the user cannot receive the challenge or accept","type":"text"},{"type":"text","text":" "},{"text":"it due to connectivity issues.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"abstract":[{"type":"text","text":"MFA recovery code that the application must display to the user, to be stored securely for future use."}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoveryCode","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"recoveryCode","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentials\/recoverycode"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#verify-with-recovery-code":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-recovery-code","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#verify-with-recovery-code"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"titleInlineContent":[{"type":"text","text":"our documentation"}],"title":"our documentation","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withRecoveryCode:mfaToken:)":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"withRecoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","title":"login(withRecoveryCode:mfaToken:)","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a recovery code."},{"type":"text","text":" "},{"type":"text","text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to"},{"text":" ","type":"text"},{"type":"text","text":"authenticate when the user’s enrolled device is unavailable, or the user cannot receive the challenge or accept"},{"type":"text","text":" "},{"text":"it due to connectivity issues.","type":"text"}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isMultifactorRequired","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn.json b/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn.json index 1c7b8c97..499af5e7 100644 --- a/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn.json +++ b/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn.json @@ -1 +1 @@ -{"kind":"symbol","defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"kind":"text","text":"("},{"text":"withUsername","kind":"externalParam"},{"kind":"text","text":" "},{"text":"username","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Username or email of the user."}]}],"name":"username"},{"name":"password","content":[{"inlineContent":[{"type":"text","text":"Password of the user."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"name":"audience"},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}]},{"content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"code":["Auth0"," .authentication()"," .loginDefaultDirectory(withUsername: \"support@auth0.com\","," password: \"secret-password\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .loginDefaultDirectory(withUsername: \"support@auth0.com\","," password: \"secret-password\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn"]}],"sections":[],"abstract":[{"text":"Logs in a user using a username and password in the default directory.","type":"text"}],"metadata":{"required":true,"externalID":"s:5Auth014AuthenticationP21loginDefaultDirectory12withUsername8password8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","role":"symbol","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"loginDefaultDirectory"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"https://auth0.com/docs/api/authentication":{"type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn":{"abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"type":"topic","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","defaultImplementations":1,"kind":"symbol","required":true,"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"loginDefaultDirectory","kind":"identifier"},{"kind":"text","text":"("},{"text":"withUsername","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8":{"abstract":[{"text":"Logs in a user using a username and password in the default directory.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","kind":"symbol","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"loginDefaultDirectory"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withUsername"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"role":"symbol","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withUsername"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","roleHeading":"Instance Method","required":true,"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP21loginDefaultDirectory12withUsername8password8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8"],"title":"Authentication Implementations"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"Username or email of the user.","type":"text"}],"type":"paragraph"}],"name":"username"},{"name":"password","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Password of the user."}]}]},{"name":"audience","content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}],"type":"paragraph"}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values."}]}]}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}],"kind":"content"},{"content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .loginDefaultDirectory(withUsername: \"support@auth0.com\","," password: \"secret-password\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .loginDefaultDirectory(withUsername: \"support@auth0.com\","," password: \"secret-password\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]}],"kind":"content"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8":{"url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"loginDefaultDirectory"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withUsername"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"abstract":[{"text":"Logs in a user using a username and password in the default directory.","type":"text"}],"type":"topic","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withUsername"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:)-4gru8.json b/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:)-4gru8.json index 09520181..7b11693e 100644 --- a/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:)-4gru8.json +++ b/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:)-4gru8.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn"]]},"abstract":[{"text":"Logs in a user using a username and password in the default directory.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"loginDefaultDirectory"},{"kind":"text","text":"("},{"text":"withUsername","kind":"externalParam"},{"kind":"text","text":" "},{"text":"username","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" = defaultScope) -> "},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"name":"username","content":[{"inlineContent":[{"type":"text","text":"Username or email of the user."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"Password of the user.","type":"text"}],"type":"paragraph"}],"name":"password"},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}]}]},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}]},{"kind":"content","content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .loginDefaultDirectory(withUsername: \"support@auth0.com\","," password: \"secret-password\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .loginDefaultDirectory(withUsername: \"support@auth0.com\","," password: \"secret-password\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","interfaceLanguage":"swift"},"metadata":{"symbolKind":"method","extendedModule":"Auth0","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","externalID":"s:5Auth014AuthenticationPAAE21loginDefaultDirectory12withUsername8password8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","role":"symbol","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"loginDefaultDirectory","kind":"identifier"},{"kind":"text","text":"("},{"text":"withUsername","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8"]}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn":{"abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"type":"topic","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","defaultImplementations":1,"kind":"symbol","required":true,"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"loginDefaultDirectory","kind":"identifier"},{"kind":"text","text":"("},{"text":"withUsername","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8":{"abstract":[{"text":"Logs in a user using a username and password in the default directory.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","kind":"symbol","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"loginDefaultDirectory"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withUsername"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]}}} \ No newline at end of file +{"kind":"symbol","sections":[],"metadata":{"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"loginDefaultDirectory"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withUsername"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"extendedModule":"Auth0","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","externalID":"s:5Auth014AuthenticationPAAE21loginDefaultDirectory12withUsername8password8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"username"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" = defaultScope) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Username or email of the user."}],"type":"paragraph"}],"name":"username"},{"name":"password","content":[{"inlineContent":[{"text":"Password of the user.","type":"text"}],"type":"paragraph"}]},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}]}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested scope values.","type":"text"}]}]}]},{"content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}],"kind":"content"},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .loginDefaultDirectory(withUsername: \"support@auth0.com\","," password: \"secret-password\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .loginDefaultDirectory(withUsername: \"support@auth0.com\","," password: \"secret-password\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]}]}],"abstract":[{"text":"Logs in a user using a username and password in the default directory.","type":"text"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn"]]},"variants":[{"paths":["\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-3uzbn","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withUsername"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","abstract":[{"type":"text","text":"Logs in a user using a username and password in the default directory."}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8":{"url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"loginDefaultDirectory"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withUsername"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"abstract":[{"text":"Logs in a user using a username and password in the default directory.","type":"text"}],"type":"topic","kind":"symbol","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692.json b/docs/data/documentation/auth0/authentication/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692.json index 90a625ec..95ebf8d5 100644 --- a/docs/data/documentation/auth0/authentication/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692.json +++ b/docs/data/documentation/auth0/authentication/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692.json @@ -1 +1 @@ -{"abstract":[{"text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the","type":"text"},{"type":"text","text":" "},{"type":"text","text":"application and user."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692"]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#challenge-request"],"title":"Related Documentation"}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"types","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"reference","isActive":true},{"text":" error due to MFA requirement.","type":"text"}],"type":"paragraph"}],"name":"mfaToken"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A list of the challenges types accepted by your application. Accepted challenge types are "},{"code":"oob","type":"codeVoice"},{"type":"text","text":" or "},{"type":"codeVoice","code":"otp"},{"type":"text","text":". Excluding this parameter means that your application accepts all supported challenge types."}]}],"name":"types"},{"name":"authenticatorId","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The ID of the authenticator to challenge. You can get the ID by querying the list of available authenticators for the user."}]}]}],"kind":"parameters"},{"content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"inlineContent":[{"type":"text","text":"A request that will yield a multi-factor challenge."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .multifactorChallenge(mfaToken: \"mfa-token\", types: [\"otp\"])"," .start { result in"," switch result {"," case .success(let challenge):"," print(\"Obtained challenge: \\(challenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"text":"The challenge type is how the user will get the challenge and prove possession. Supported challenge types include:","type":"text"}],"type":"paragraph"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"code":"otp","type":"codeVoice"},{"text":": for one-time password (OTP)","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"codeVoice","code":"oob"},{"type":"text","text":": for SMS\/voice messages or out-of-band (OOB)"}],"type":"paragraph"}]}],"type":"unorderedList"}]}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationP20multifactorChallenge8mfaToken5types15authenticatorIdAA7RequestVyAA0D0VAA0B5ErrorVGSS_SaySSGSgSSSgtF","required":true,"title":"multifactorChallenge(mfaToken:types:authenticatorId:)","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"method","roleHeading":"Instance Method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct":{"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"multifactorChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]?, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"multifactorChallenge(mfaToken:types:authenticatorId:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct","abstract":[{"type":"text","text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the"},{"text":" ","type":"text"},{"text":"application and user.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692":{"required":true,"title":"multifactorChallenge(mfaToken:types:authenticatorId:)","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","role":"symbol","defaultImplementations":1,"abstract":[{"text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the","type":"text"},{"text":" ","type":"text"},{"text":"application and user.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"multifactorChallenge"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]?, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A multi-factor challenge."}],"url":"\/documentation\/auth0\/challenge","title":"Challenge","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/api/authentication#challenge-request":{"title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request"}}} \ No newline at end of file +{"metadata":{"required":true,"title":"multifactorChallenge(mfaToken:types:authenticatorId:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]?, "},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"symbolKind":"method","externalID":"s:5Auth014AuthenticationP20multifactorChallenge8mfaToken5types15authenticatorIdAA7RequestVyAA0D0VAA0B5ErrorVGSS_SaySSGSgSSSgtF","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"type":"text","text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the"},{"text":" ","type":"text"},{"type":"text","text":"application and user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct"],"title":"Authentication Implementations"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth09ChallengeV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","text":"Challenge","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"reference"},{"text":" error due to MFA requirement.","type":"text"}]}],"name":"mfaToken"},{"name":"types","content":[{"type":"paragraph","inlineContent":[{"text":"A list of the challenges types accepted by your application. Accepted challenge types are ","type":"text"},{"code":"oob","type":"codeVoice"},{"type":"text","text":" or "},{"code":"otp","type":"codeVoice"},{"type":"text","text":". Excluding this parameter means that your application accepts all supported challenge types."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The ID of the authenticator to challenge. You can get the ID by querying the list of available authenticators for the user."}]}],"name":"authenticatorId"}]},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield a multi-factor challenge.","type":"text"}]}]},{"kind":"content","content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"code":["Auth0"," .authentication()"," .multifactorChallenge(mfaToken: \"mfa-token\", types: [\"otp\"])"," .start { result in"," switch result {"," case .success(let challenge):"," print(\"Obtained challenge: \\(challenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift","type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The challenge type is how the user will get the challenge and prove possession. Supported challenge types include:"}]},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"code":"otp","type":"codeVoice"},{"type":"text","text":": for one-time password (OTP)"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"code":"oob","type":"codeVoice"},{"text":": for SMS\/voice messages or out-of-band (OOB)","type":"text"}]}]}],"type":"unorderedList"}]}],"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#challenge-request"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isMultifactorRequired","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct":{"type":"topic","role":"symbol","abstract":[{"text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the","type":"text"},{"type":"text","text":" "},{"type":"text","text":"application and user."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"multifactorChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"types","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"text":"Challenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09ChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","kind":"symbol","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct","title":"multifactorChallenge(mfaToken:types:authenticatorId:)"},"https://auth0.com/docs/api/authentication#challenge-request":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request","title":"Authentication API Endpoint","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","role":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","kind":"symbol","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"multifactorChallenge"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","abstract":[{"text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"application and user."}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct.json b/docs/data/documentation/auth0/authentication/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct.json index 4ef7fd92..365d408d 100644 --- a/docs/data/documentation/auth0/authentication/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct.json +++ b/docs/data/documentation/auth0/authentication/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct.json @@ -1 +1 @@ -{"abstract":[{"text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the","type":"text"},{"type":"text","text":" "},{"text":"application and user.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","interfaceLanguage":"swift"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#challenge-request"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]? = nil, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},{"text":" error due to MFA requirement.","type":"text"}],"type":"paragraph"}],"name":"mfaToken"},{"content":[{"inlineContent":[{"text":"A list of the challenges types accepted by your application. Accepted challenge types are ","type":"text"},{"code":"oob","type":"codeVoice"},{"type":"text","text":" or "},{"type":"codeVoice","code":"otp"},{"type":"text","text":". Excluding this parameter means that your application accepts all supported challenge types."}],"type":"paragraph"}],"name":"types"},{"name":"authenticatorId","content":[{"inlineContent":[{"text":"The ID of the authenticator to challenge. You can get the ID by querying the list of available authenticators for the user.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a multi-factor challenge."}]}]},{"kind":"content","content":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .multifactorChallenge(mfaToken: \"mfa-token\", types: [\"otp\"])"," .start { result in"," switch result {"," case .success(let challenge):"," print(\"Obtained challenge: \\(challenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The challenge type is how the user will get the challenge and prove possession. Supported challenge types include:"}]},{"items":[{"content":[{"inlineContent":[{"type":"codeVoice","code":"otp"},{"text":": for one-time password (OTP)","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"oob"},{"text":": for SMS\/voice messages or out-of-band (OOB)","type":"text"}]}]}],"type":"unorderedList"}]}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct"]}],"metadata":{"title":"multifactorChallenge(mfaToken:types:authenticatorId:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]?, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Challenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09ChallengeV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"symbolKind":"method","extendedModule":"Auth0","role":"symbol","externalID":"s:5Auth014AuthenticationPAAE20multifactorChallenge8mfaToken5types15authenticatorIdAA7RequestVyAA0D0VAA0B5ErrorVGSS_SaySSGSgSSSgtF","roleHeading":"Instance Method"},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct":{"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"multifactorChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]?, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"multifactorChallenge(mfaToken:types:authenticatorId:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct","abstract":[{"type":"text","text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the"},{"text":" ","type":"text"},{"text":"application and user.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A multi-factor challenge."}],"url":"\/documentation\/auth0\/challenge","title":"Challenge","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692":{"required":true,"title":"multifactorChallenge(mfaToken:types:authenticatorId:)","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","role":"symbol","defaultImplementations":1,"abstract":[{"text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the","type":"text"},{"text":" ","type":"text"},{"text":"application and user.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"multifactorChallenge"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]?, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"isMultifactorRequired"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/api/authentication#challenge-request":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request","url":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request","title":"Authentication API Endpoint"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]? = nil, "},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Token returned when authentication fails with an ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},{"type":"text","text":" error due to MFA requirement."}]}],"name":"mfaToken"},{"name":"types","content":[{"inlineContent":[{"type":"text","text":"A list of the challenges types accepted by your application. Accepted challenge types are "},{"type":"codeVoice","code":"oob"},{"type":"text","text":" or "},{"type":"codeVoice","code":"otp"},{"text":". Excluding this parameter means that your application accepts all supported challenge types.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The ID of the authenticator to challenge. You can get the ID by querying the list of available authenticators for the user."}]}],"name":"authenticatorId"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a multi-factor challenge."}]}],"kind":"content"},{"kind":"content","content":[{"anchor":"Usage","text":"Usage","level":2,"type":"heading"},{"code":["Auth0"," .authentication()"," .multifactorChallenge(mfaToken: \"mfa-token\", types: [\"otp\"])"," .start { result in"," switch result {"," case .success(let challenge):"," print(\"Obtained challenge: \\(challenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"text":"The challenge type is how the user will get the challenge and prove possession. Supported challenge types include:","type":"text"}],"type":"paragraph"},{"items":[{"content":[{"inlineContent":[{"type":"codeVoice","code":"otp"},{"type":"text","text":": for one-time password (OTP)"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"oob"},{"text":": for SMS\/voice messages or out-of-band (OOB)","type":"text"}]}]}],"type":"unorderedList"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct"]}],"abstract":[{"type":"text","text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the"},{"type":"text","text":" "},{"text":"application and user.","type":"text"}],"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#challenge-request"],"title":"Related Documentation"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692"]]},"metadata":{"extendedModule":"Auth0","externalID":"s:5Auth014AuthenticationPAAE20multifactorChallenge8mfaToken5types15authenticatorIdAA7RequestVyAA0D0VAA0B5ErrorVGSS_SaySSGSgSSSgtF","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"multifactorChallenge"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]?, "},{"text":"authenticatorId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier","text":"Challenge"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct"},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-3p692","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"multifactorChallenge"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","abstract":[{"text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"application and user."}],"required":true,"role":"symbol","defaultImplementations":1},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"https://auth0.com/docs/api/authentication#challenge-request":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#challenge-request","title":"Authentication API Endpoint","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","role":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","kind":"symbol","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct":{"type":"topic","role":"symbol","abstract":[{"text":"Requests a challenge for multi-factor authentication (MFA) based on the challenge types supported by the","type":"text"},{"type":"text","text":" "},{"type":"text","text":"application and user."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"multifactorChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"types","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"text":"Challenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09ChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","kind":"symbol","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct","title":"multifactorChallenge(mfaToken:types:authenticatorId:)"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isMultifactorRequired","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:scope:)-2llyg.json b/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:scope:)-2llyg.json index a7e479d0..6286784a 100644 --- a/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:scope:)-2llyg.json +++ b/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:scope:)-2llyg.json @@ -1 +1 @@ -{"abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"externalID":"s:5Auth014AuthenticationP5renew16withRefreshToken5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SSSgtF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"title":"renew(withRefreshToken:scope:)","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"required":true,"symbolKind":"method","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"kind":"text","text":" "},{"text":"refreshToken","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The refresh token."}],"type":"paragraph"}],"name":"refreshToken"},{"name":"scope","content":[{"inlineContent":[{"text":"Space-separated list of scope values to request. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"type":"text","text":", which will ask for the same scopes that were originally requested on login."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken)"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained new credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can get a downscoped access token by requesting fewer scopes than were originally requested on login:"}]},{"syntax":"swift","code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken,"," scope: \"openid offline_access\")"," .start { print($0) }"],"type":"codeListing"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/api/authentication#refresh-token":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-2llyg":{"abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","title":"renew(withRefreshToken:scope:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"abstract":[],"kind":"article","url":"\/documentation\/auth0\/refreshtokens","title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-8vkbb":{"role":"symbol","title":"renew(withRefreshToken:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]}}} \ No newline at end of file +{"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"refreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"refreshToken","content":[{"type":"paragraph","inlineContent":[{"text":"The refresh token.","type":"text"}]}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of scope values to request. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":", which will ask for the same scopes that were originally requested on login."}]}]}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken)"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained new credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"text":"You can get a downscoped access token by requesting fewer scopes than were originally requested on login:","type":"text"}]},{"code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken,"," scope: \"openid offline_access\")"," .start { print($0) }"],"syntax":"swift","type":"codeListing"}]}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb"],"title":"Authentication Implementations"}],"metadata":{"externalID":"s:5Auth014AuthenticationP5renew16withRefreshToken5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SSSgtF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"text":"withRefreshToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","required":true,"title":"renew(withRefreshToken:scope:)","modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"role":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors","kind":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","abstract":[]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-2llyg":{"abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"required":true,"defaultImplementations":1,"kind":"symbol","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg","title":"renew(withRefreshToken:scope:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-8vkbb":{"abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb","title":"renew(withRefreshToken:scope:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}]},"https://auth0.com/docs/api/authentication#refresh-token":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:scope:)-8vkbb.json b/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:scope:)-8vkbb.json index baa34ec1..3532b0f3 100644 --- a/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:scope:)-8vkbb.json +++ b/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:scope:)-8vkbb.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"metadata":{"title":"renew(withRefreshToken:scope:)","role":"symbol","externalID":"s:5Auth014AuthenticationPAAE5renew16withRefreshToken5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SSSgtF","modules":[{"name":"Auth0"}],"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withRefreshToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","extendedModule":"Auth0"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg"]]},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"refreshToken"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil) -> "},{"kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"refreshToken","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The refresh token."}]}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of scope values to request. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":", which will ask for the same scopes that were originally requested on login."}]}]}]},{"content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken)"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained new credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can get a downscoped access token by requesting fewer scopes than were originally requested on login:"}]},{"syntax":"swift","code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken,"," scope: \"openid offline_access\")"," .start { print($0) }"],"type":"codeListing"}]}],"abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"abstract":[],"kind":"article","url":"\/documentation\/auth0\/refreshtokens","title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-2llyg":{"abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","title":"renew(withRefreshToken:scope:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol","defaultImplementations":1},"https://auth0.com/docs/api/authentication":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}]},"https://auth0.com/docs/api/authentication#refresh-token":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-8vkbb":{"role":"symbol","title":"renew(withRefreshToken:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg"]]},"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"text":"withRefreshToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil) -> "},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The refresh token.","type":"text"}]}],"name":"refreshToken"},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of scope values to request. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":", which will ask for the same scopes that were originally requested on login.","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}]},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken)"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained new credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"text":"You can get a downscoped access token by requesting fewer scopes than were originally requested on login:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken,"," scope: \"openid offline_access\")"," .start { print($0) }"],"type":"codeListing"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth014AuthenticationPAAE5renew16withRefreshToken5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SSSgtF","extendedModule":"Auth0","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"symbolKind":"method","title":"renew(withRefreshToken:scope:)","role":"symbol"},"references":{"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-8vkbb":{"abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-8vkbb","title":"renew(withRefreshToken:scope:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}]},"https://auth0.com/docs/api/authentication#refresh-token":{"title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:scope:)-2llyg":{"abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"required":true,"defaultImplementations":1,"kind":"symbol","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:scope:)-2llyg","title":"renew(withRefreshToken:scope:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"role":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors","kind":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/resetpassword(email:connection:).json b/docs/data/documentation/auth0/authentication/resetpassword(email:connection:).json index 040e3789..c9b2de0d 100644 --- a/docs/data/documentation/auth0/authentication/resetpassword(email:connection:).json +++ b/docs/data/documentation/auth0/authentication/resetpassword(email:connection:).json @@ -1 +1 @@ -{"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#change-password"],"title":"Related Documentation"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"text":"Resets the password of a database user.","type":"text"}],"metadata":{"externalID":"s:5Auth014AuthenticationP13resetPassword5email10connectionAA7RequestVyytAA0B5ErrorVGSS_SStF","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"resetPassword"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"symbolKind":"method","title":"resetPassword(email:connection:)","roleHeading":"Instance Method","modules":[{"name":"Auth0"}]},"variants":[{"paths":["\/documentation\/auth0\/authentication\/resetpassword(email:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"resetPassword"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"email","content":[{"inlineContent":[{"type":"text","text":"Email of the database user."}],"type":"paragraph"}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the database connection."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request for resetting the password."}]}],"kind":"content"},{"kind":"content","content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .resetPassword(email: \"support@auth0.com\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"],"type":"codeListing"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/authentication#change-password":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#change-password","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#change-password","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/resetPassword(email:connection:)":{"abstract":[{"type":"text","text":"Resets the password of a database user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)","title":"resetPassword(email:connection:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"resetPassword"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"email","content":[{"inlineContent":[{"type":"text","text":"Email of the database user."}],"type":"paragraph"}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"text":"Name of the database connection.","type":"text"}]}]}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A request for resetting the password.","type":"text"}]}]},{"kind":"content","content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"type":"codeListing","code":["Auth0"," .authentication()"," .resetPassword(email: \"support@auth0.com\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"],"syntax":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"abstract":[{"type":"text","text":"Resets the password of a database user."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#change-password"]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/resetpassword(email:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"required":true,"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP13resetPassword5email10connectionAA7RequestVyytAA0B5ErrorVGSS_SStF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"symbolKind":"method","role":"symbol","title":"resetPassword(email:connection:)"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)"},"references":{"https://auth0.com/docs/api/authentication#change-password":{"title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#change-password","type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#change-password"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/resetPassword(email:connection:)":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"resetPassword","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)","title":"resetPassword(email:connection:)","abstract":[{"text":"Resets the password of a database user.","type":"text"}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/revoke(refreshtoken:).json b/docs/data/documentation/auth0/authentication/revoke(refreshtoken:).json index 1dda5895..4b5a5658 100644 --- a/docs/data/documentation/auth0/authentication/revoke(refreshtoken:).json +++ b/docs/data/documentation/auth0/authentication/revoke(refreshtoken:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/revoke(refreshtoken:)"]}],"metadata":{"role":"symbol","required":true,"externalID":"s:5Auth014AuthenticationP6revoke12refreshTokenAA7RequestVyytAA0B5ErrorVGSS_tF","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"symbolKind":"method","title":"revoke(refreshToken:)"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"Revokes a user’s refresh token by performing a request to the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint."}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke"],"title":"Related Documentation"}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The refresh token to revoke."}]}],"name":"refreshToken"}]},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request for revoking the refresh token."}]}],"kind":"content"},{"kind":"content","content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .revoke(refreshToken: credentials.refreshToken)"," .start { print($0) }"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/revoke(refreshToken:)":{"abstract":[{"type":"text","text":"Revokes a user’s refresh token by performing a request to the "},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)","title":"revoke(refreshToken:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/api/authentication#post-oauth-revoke":{"titleInlineContent":[{"type":"text","text":"Error Responses"}],"title":"Error Responses","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Revokes a user’s refresh token by performing a request to the "},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The refresh token to revoke."}],"type":"paragraph"}],"name":"refreshToken"}]},{"content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"A request for revoking the refresh token.","type":"text"}]}],"kind":"content"},{"content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .revoke(refreshToken: credentials.refreshToken)"," .start { print($0) }"]}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"required":true,"modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol","title":"revoke(refreshToken:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationP6revoke12refreshTokenAA7RequestVyytAA0B5ErrorVGSS_tF","roleHeading":"Instance Method"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/revoke(refreshtoken:)"]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","references":{"https://auth0.com/docs/api/authentication#post-oauth-revoke":{"type":"link","title":"Error Responses","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke","titleInlineContent":[{"text":"Error Responses","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/revoke(refreshToken:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","role":"symbol","abstract":[{"type":"text","text":"Revokes a user’s refresh token by performing a request to the "},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint."}],"type":"topic","title":"revoke(refreshToken:)","url":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)","kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]},"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y.json b/docs/data/documentation/auth0/authentication/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y.json index 7aa1970f..bd89dee6 100644 --- a/docs/data/documentation/auth0/authentication/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y.json +++ b/docs/data/documentation/auth0/authentication/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"type":"text","text":"Creates a user in a database connection."}],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","symbolKind":"method","role":"symbol","required":true,"externalID":"s:5Auth014AuthenticationP6signup5email8username8password10connection12userMetadata14rootAttributesAA7RequestVySSAE_SSSgAFSb8verifiedtAA0B5ErrorVGSS_AMS2SSDySSypGSgAStF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"signup"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}]},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#signup"]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"username"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"text":"rootAttributes","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"email","content":[{"type":"paragraph","inlineContent":[{"text":"Email for the new user.","type":"text"}]}]},{"name":"username","content":[{"inlineContent":[{"text":"Username for the new user (if the connection requires a username). Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Password for the new user."}]}],"name":"password"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the connection where the user will be created (database connection).","type":"text"}]}],"name":"connection"},{"content":[{"inlineContent":[{"text":"Additional user metadata parameters that will be added to the newly created user.","type":"text"}],"type":"paragraph"}],"name":"userMetadata"},{"content":[{"inlineContent":[{"text":"Root attributes that will be added to the newly created user. These will not overwrite existing parameters. See https:\/\/auth0.com\/docs\/api\/authentication#signup for the full list of supported attributes.","type":"text"}],"type":"paragraph"}],"name":"rootAttributes"}]},{"content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request that will yield a newly created database user (just the email, username, and email verified flag)."}],"type":"paragraph"}],"kind":"content"},{"content":[{"text":"Usage","anchor":"Usage","level":2,"type":"heading"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let user):"," print(\"User signed up: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also add additional metadata when creating the user:"}]},{"syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\","," userMetadata: [\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .start { print($0) }"],"type":"codeListing"},{"inlineContent":[{"text":"If the database connection requires a username:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," username: \"support\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"],"type":"codeListing"}],"kind":"content"}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l","type":"topic","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"rootAttributes"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth012DatabaseUsera","kind":"typeIdentifier","text":"DatabaseUser"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Creates a user in a database connection."}],"role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"DatabaseUser","kind":"identifier"}],"navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"url":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"https://auth0.com/docs/api/authentication#signup":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#signup","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#signup","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y":{"kind":"symbol","type":"topic","required":true,"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"signup","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"text":"rootAttributes","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Creates a user in a database connection."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y"}}} \ No newline at end of file +{"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#signup"]}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l"],"title":"Authentication Implementations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y"},"sections":[],"abstract":[{"text":"Creates a user in a database connection.","type":"text"}],"metadata":{"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","externalID":"s:5Auth014AuthenticationP6signup5email8username8password10connection12userMetadata14rootAttributesAA7RequestVySSAE_SSSgAFSb8verifiedtAA0B5ErrorVGSS_AMS2SSDySSypGSgAStF","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"signup","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"required":true,"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"method"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"text":"rootAttributes","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"kind":"text","text":">"}],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Email for the new user."}],"type":"paragraph"}],"name":"email"},{"content":[{"inlineContent":[{"type":"text","text":"Username for the new user (if the connection requires a username). Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"username"},{"name":"password","content":[{"inlineContent":[{"text":"Password for the new user.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Name of the connection where the user will be created (database connection)."}],"type":"paragraph"}],"name":"connection"},{"content":[{"inlineContent":[{"type":"text","text":"Additional user metadata parameters that will be added to the newly created user."}],"type":"paragraph"}],"name":"userMetadata"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Root attributes that will be added to the newly created user. These will not overwrite existing parameters. See https:\/\/auth0.com\/docs\/api\/authentication#signup for the full list of supported attributes."}]}],"name":"rootAttributes"}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a newly created database user (just the email, username, and email verified flag)."}]}]},{"content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let user):"," print(\"User signed up: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"text":"You can also add additional metadata when creating the user:","type":"text"}],"type":"paragraph"},{"code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\","," userMetadata: [\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .start { print($0) }"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"text":"If the database connection requires a username:","type":"text"}],"type":"paragraph"},{"code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," username: \"support\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"url":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l","abstract":[{"text":"Creates a user in a database connection.","type":"text"}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#signup":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#signup","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#signup","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"username"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]?, ","kind":"text"},{"text":"rootAttributes","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","abstract":[{"text":"Creates a user in a database connection.","type":"text"}],"required":true,"role":"symbol","defaultImplementations":1},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l.json b/docs/data/documentation/auth0/authentication/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l.json index 2ee95ead..ee1c7d5b 100644 --- a/docs/data/documentation/auth0/authentication/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l.json +++ b/docs/data/documentation/auth0/authentication/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"signup","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"userMetadata","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]? = nil, "},{"kind":"externalParam","text":"rootAttributes"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]? = nil) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth012DatabaseUsera","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","text":"DatabaseUser"},{"kind":"text","text":", "},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Email for the new user."}]}],"name":"email"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Username for the new user (if the connection requires a username). Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}],"name":"username"},{"name":"password","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Password for the new user."}]}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"text":"Name of the connection where the user will be created (database connection).","type":"text"}]}]},{"name":"userMetadata","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional user metadata parameters that will be added to the newly created user."}]}]},{"name":"rootAttributes","content":[{"inlineContent":[{"text":"Root attributes that will be added to the newly created user. These will not overwrite existing parameters. See https:\/\/auth0.com\/docs\/api\/authentication#signup for the full list of supported attributes.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a newly created database user (just the email, username, and email verified flag)."}]}]},{"content":[{"level":2,"type":"heading","text":"Usage","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let user):"," print(\"User signed up: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"inlineContent":[{"text":"You can also add additional metadata when creating the user:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\","," userMetadata: [\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .start { print($0) }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"If the database connection requires a username:"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," username: \"support\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"],"type":"codeListing"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y"]]},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l"},"schemaVersion":{"patch":0,"major":0,"minor":3},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#signup"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l"]}],"metadata":{"extendedModule":"Auth0","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"username"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"text":"rootAttributes","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationPAAE6signup5email8username8password10connection12userMetadata14rootAttributesAA7RequestVySSAE_SSSgAFSb8verifiedtAA0B5ErrorVGSS_AMS2SSDySSypGSgAStF"},"sections":[],"abstract":[{"text":"Creates a user in a database connection.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y":{"kind":"symbol","type":"topic","required":true,"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"signup","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"text":"rootAttributes","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Creates a user in a database connection."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"DatabaseUser","kind":"identifier"}],"navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"url":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","role":"symbol","type":"topic"},"https://auth0.com/docs/api/authentication#signup":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#signup","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#signup","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l","type":"topic","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"rootAttributes"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth012DatabaseUsera","kind":"typeIdentifier","text":"DatabaseUser"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Creates a user in a database connection."}],"role":"symbol","kind":"symbol"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#signup"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"username","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"userMetadata"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]? = nil, "},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]? = nil) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth012DatabaseUsera","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","text":"DatabaseUser"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"Email for the new user.","type":"text"}],"type":"paragraph"}],"name":"email"},{"content":[{"inlineContent":[{"type":"text","text":"Username for the new user (if the connection requires a username). Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"username"},{"content":[{"inlineContent":[{"type":"text","text":"Password for the new user."}],"type":"paragraph"}],"name":"password"},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"text":"Name of the connection where the user will be created (database connection).","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Additional user metadata parameters that will be added to the newly created user."}],"type":"paragraph"}],"name":"userMetadata"},{"name":"rootAttributes","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Root attributes that will be added to the newly created user. These will not overwrite existing parameters. See https:\/\/auth0.com\/docs\/api\/authentication#signup for the full list of supported attributes."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a newly created database user (just the email, username, and email verified flag)."}]}]},{"content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let user):"," print(\"User signed up: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"text":"You can also add additional metadata when creating the user:","type":"text"}]},{"syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\","," userMetadata: [\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .start { print($0) }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"If the database connection requires a username:"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," username: \"support\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"]}],"kind":"content"}],"abstract":[{"type":"text","text":"Creates a user in a database connection."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y"]]},"metadata":{"roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationPAAE6signup5email8username8password10connection12userMetadata14rootAttributesAA7RequestVySSAE_SSSgAFSb8verifiedtAA0B5ErrorVGSS_AMS2SSDySSypGSgAStF","role":"symbol","modules":[{"name":"Auth0"}],"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"text":"rootAttributes","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"extendedModule":"Auth0","symbolKind":"method"},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l","abstract":[{"text":"Creates a user in a database connection.","type":"text"}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l"},"https://auth0.com/docs/api/authentication#signup":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#signup","type":"link","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#signup"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/api/authentication":{"type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"url":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-4rw4y","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"username"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"password","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]?, ","kind":"text"},{"text":"rootAttributes","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","abstract":[{"text":"Creates a user in a database connection.","type":"text"}],"required":true,"role":"symbol","defaultImplementations":1}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/startpasswordless(email:type:connection:)-56xbe.json b/docs/data/documentation/auth0/authentication/startpasswordless(email:type:connection:)-56xbe.json index 81f6a6fd..9befd400 100644 --- a/docs/data/documentation/auth0/authentication/startpasswordless(email:type:connection:)-56xbe.json +++ b/docs/data/documentation/auth0/authentication/startpasswordless(email:type:connection:)-56xbe.json @@ -1 +1 @@ -{"metadata":{"role":"symbol","externalID":"s:5Auth014AuthenticationP17startPasswordless5email4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","title":"startPasswordless(email:type:connection:)","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"symbolKind":"method","required":true},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe"},"abstract":[{"text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the","type":"text"},{"type":"text","text":" "},{"type":"text","text":"passwordless login flow."}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"],"title":"Related Documentation"}],"sections":[],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Email where to send the code or link.","type":"text"}]}],"name":"email"},{"content":[{"inlineContent":[{"text":"Type of passwordless authentication. Defaults to ‘code’.","type":"text"}],"type":"paragraph"}],"name":"type"},{"content":[{"inlineContent":[{"type":"text","text":"Name of the passwordless connection. Defaults to ‘email’."}],"type":"paragraph"}],"name":"connection"}]},{"content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"anchor":"Usage","text":"Usage","level":2,"type":"heading"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\")"," .start { print($0) }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you have configured iOS Universal Links:"}]},{"type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\", type: .iOSLink)"," .start { print($0) }"],"syntax":"swift"},{"content":[{"inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp","type":"codeVoice"},{"text":". Check","type":"text"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}],"type":"paragraph"}],"style":"note","type":"aside","name":"Requires"}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"https://auth0.com/docs/get-started/applications/application-grant-types":{"title":"our documentation","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","titleInlineContent":[{"text":"our documentation","type":"text"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"https://auth0.com/docs/api/authentication#get-code-or-link":{"title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link"},"https://auth0.com/docs/api/authentication#post-passwordless-start":{"title":"Error Responses","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","type":"link","titleInlineContent":[{"text":"Error Responses","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-56xbe":{"required":true,"defaultImplementations":1,"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe","title":"startPasswordless(email:type:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","abstract":[{"type":"text","text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the"},{"type":"text","text":" "},{"type":"text","text":"passwordless login flow."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-6xl8p":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p","title":"startPasswordless(email:type:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","abstract":[{"text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"passwordless login flow."}]},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"}}} \ No newline at end of file +{"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"text":": ","kind":"text"},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"email","content":[{"inlineContent":[{"text":"Email where to send the code or link.","type":"text"}],"type":"paragraph"}]},{"name":"type","content":[{"inlineContent":[{"type":"text","text":"Type of passwordless authentication. Defaults to ‘code’."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"Name of the passwordless connection. Defaults to ‘email’.","type":"text"}],"type":"paragraph"}],"name":"connection"}]},{"content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"type":"heading","text":"Usage","anchor":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\")"," .start { print($0) }"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"text":"If you have configured iOS Universal Links:","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\", type: .iOSLink)"," .start { print($0) }"]},{"type":"aside","name":"Requires","content":[{"inlineContent":[{"text":"Passwordless OTP Grant ","type":"text"},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp","type":"codeVoice"},{"type":"text","text":". Check"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"reference","isActive":true},{"type":"text","text":" for more information."}],"type":"paragraph"}],"style":"note"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe"},"abstract":[{"type":"text","text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the"},{"text":" ","type":"text"},{"type":"text","text":"passwordless login flow."}],"sections":[],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p"]}],"metadata":{"externalID":"s:5Auth014AuthenticationP17startPasswordless5email4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","modules":[{"name":"Auth0"}],"symbolKind":"method","roleHeading":"Instance Method","title":"startPasswordless(email:type:connection:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"type","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"required":true},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe"]}],"kind":"symbol","references":{"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-56xbe":{"required":true,"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"defaultImplementations":1,"title":"startPasswordless(email:type:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe","abstract":[{"text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the","type":"text"},{"type":"text","text":" "},{"text":"passwordless login flow.","type":"text"}]},"https://auth0.com/docs/api/authentication#post-passwordless-start":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","title":"Error Responses","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","titleInlineContent":[{"type":"text","text":"Error Responses"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-6xl8p":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"type":"topic","title":"startPasswordless(email:type:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p","abstract":[{"type":"text","text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the"},{"text":" ","type":"text"},{"text":"passwordless login flow.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#get-code-or-link":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","title":"our documentation","titleInlineContent":[{"text":"our documentation","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/startpasswordless(email:type:connection:)-6xl8p.json b/docs/data/documentation/auth0/authentication/startpasswordless(email:type:connection:)-6xl8p.json index b34a4303..78503439 100644 --- a/docs/data/documentation/auth0/authentication/startpasswordless(email:type:connection:)-6xl8p.json +++ b/docs/data/documentation/auth0/authentication/startpasswordless(email:type:connection:)-6xl8p.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the"},{"type":"text","text":" "},{"text":"passwordless login flow.","type":"text"}],"metadata":{"symbolKind":"method","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"title":"startPasswordless(email:type:connection:)","externalID":"s:5Auth014AuthenticationPAAE17startPasswordless5email4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","roleHeading":"Instance Method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]},"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"],"title":"Related Documentation"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"typeIdentifier","text":"PasswordlessType"},{"text":" = .code, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" = \"email\") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"email","content":[{"inlineContent":[{"text":"Email where to send the code or link.","type":"text"}],"type":"paragraph"}]},{"name":"type","content":[{"inlineContent":[{"type":"text","text":"Type of passwordless authentication. Defaults to ‘code’."}],"type":"paragraph"}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the passwordless connection. Defaults to ‘email’."}]}]}]},{"kind":"content","content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}]}]},{"content":[{"anchor":"Usage","level":2,"type":"heading","text":"Usage"},{"code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"If you have configured iOS Universal Links:"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\", type: .iOSLink)"," .start { print($0) }"]},{"style":"note","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"text":"Passwordless OTP Grant ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"text":". Check","type":"text"},{"text":" ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}]}],"type":"aside"}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p"]}],"references":{"https://auth0.com/docs/api/authentication":{"type":"link","title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"https://auth0.com/docs/api/authentication#post-passwordless-start":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","titleInlineContent":[{"text":"Error Responses","type":"text"}],"title":"Error Responses","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-6xl8p":{"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p","title":"startPasswordless(email:type:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","abstract":[{"text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"passwordless login flow."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"title":"our documentation","titleInlineContent":[{"text":"our documentation","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-56xbe":{"required":true,"defaultImplementations":1,"role":"symbol","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe","title":"startPasswordless(email:type:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","abstract":[{"type":"text","text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the"},{"type":"text","text":" "},{"type":"text","text":"passwordless login flow."}]},"https://auth0.com/docs/api/authentication#get-code-or-link":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"text":": ","kind":"text"},{"text":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"text":" = .code, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" = \"email\") -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Email where to send the code or link.","type":"text"}],"type":"paragraph"}],"name":"email"},{"name":"type","content":[{"inlineContent":[{"text":"Type of passwordless authentication. Defaults to ‘code’.","type":"text"}],"type":"paragraph"}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the passwordless connection. Defaults to ‘email’."}]}]}]},{"content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request for starting the passwordless flow.","type":"text"}]}],"kind":"content"},{"kind":"content","content":[{"level":2,"type":"heading","text":"Usage","anchor":"Usage"},{"type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\")"," .start { print($0) }"],"syntax":"swift"},{"inlineContent":[{"type":"text","text":"If you have configured iOS Universal Links:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\", type: .iOSLink)"," .start { print($0) }"]},{"type":"aside","name":"Requires","content":[{"inlineContent":[{"text":"Passwordless OTP Grant ","type":"text"},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp","type":"codeVoice"},{"type":"text","text":". Check"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}],"type":"paragraph"}],"style":"note"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe"]]},"sections":[],"abstract":[{"type":"text","text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the"},{"type":"text","text":" "},{"text":"passwordless login flow.","type":"text"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationPAAE17startPasswordless5email4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"type","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier","text":"PasswordlessType"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"symbolKind":"method","role":"symbol","title":"startPasswordless(email:type:connection:)"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"},"https://auth0.com/docs/api/authentication#post-passwordless-start":{"title":"Error Responses","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","titleInlineContent":[{"text":"Error Responses","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-56xbe":{"required":true,"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"defaultImplementations":1,"title":"startPasswordless(email:type:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-56xbe","kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe","abstract":[{"text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the","type":"text"},{"type":"text","text":" "},{"text":"passwordless login flow.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/api/authentication#get-code-or-link":{"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-6xl8p":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"type":"topic","title":"startPasswordless(email:type:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p","abstract":[{"type":"text","text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the"},{"text":" ","type":"text"},{"text":"passwordless login flow.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:)-5azmm.json b/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:)-5azmm.json index 1ac7c3c4..d35dfa7f 100644 --- a/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:)-5azmm.json +++ b/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:)-5azmm.json @@ -1 +1 @@ -{"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"startPasswordless(phoneNumber:type:connection:)","extendedModule":"Auth0","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationPAAE17startPasswordless11phoneNumber4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","symbolKind":"method","role":"symbol"},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":" = .code, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" = \"sms\") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Phone number where to send the SMS with the code or link.","type":"text"}],"type":"paragraph"}],"name":"phoneNumber"},{"name":"type","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Type of passwordless authentication. Defaults to ‘code’."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the passwordless connection. Defaults to ‘sms’.","type":"text"}]}],"name":"connection"}],"kind":"parameters"},{"content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"If you have configured iOS Universal Links:"}],"type":"paragraph"},{"type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\", type: .iOSLink)"," .start { print($0) }"],"syntax":"swift"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"type":"text","text":". Check"},{"text":" ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}],"type":"paragraph"}],"type":"aside","name":"Requires"}],"kind":"content"}],"kind":"symbol","abstract":[{"type":"text","text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless"},{"type":"text","text":" "},{"text":"login flow.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","interfaceLanguage":"swift"},"references":{"https://auth0.com/docs/api/authentication#get-code-or-link":{"title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","type":"link"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"https://auth0.com/docs/api/authentication#post-passwordless-start":{"titleInlineContent":[{"type":"text","text":"Error Responses"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","title":"Error Responses"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-5azmm":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","title":"startPasswordless(phoneNumber:type:connection:)","role":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm","abstract":[{"text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless","type":"text"},{"text":" ","type":"text"},{"text":"login flow.","type":"text"}],"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-9unt":{"abstract":[{"text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless","type":"text"},{"type":"text","text":" "},{"type":"text","text":"login flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt","title":"startPasswordless(phoneNumber:type:connection:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"role":"symbol","defaultImplementations":1},"https://auth0.com/docs/get-started/applications/application-grant-types":{"title":"our documentation","type":"link","titleInlineContent":[{"type":"text","text":"our documentation"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"text":"phoneNumber","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},{"text":" = .code, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" = \"sms\") -> "},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Phone number where to send the SMS with the code or link.","type":"text"}]}],"name":"phoneNumber"},{"content":[{"inlineContent":[{"text":"Type of passwordless authentication. Defaults to ‘code’.","type":"text"}],"type":"paragraph"}],"name":"type"},{"content":[{"inlineContent":[{"type":"text","text":"Name of the passwordless connection. Defaults to ‘sms’."}],"type":"paragraph"}],"name":"connection"}]},{"content":[{"text":"Return Value","anchor":"return-value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}]}],"kind":"content"},{"kind":"content","content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\")"," .start { print($0) }"],"syntax":"swift","type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you have configured iOS Universal Links:"}]},{"type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\", type: .iOSLink)"," .start { print($0) }"],"syntax":"swift"},{"type":"aside","name":"Requires","style":"note","content":[{"inlineContent":[{"text":"Passwordless OTP Grant ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"type":"text","text":". Check"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"reference","isActive":true},{"type":"text","text":" for more information."}],"type":"paragraph"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt"]]},"abstract":[{"type":"text","text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless"},{"text":" ","type":"text"},{"text":"login flow.","type":"text"}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"text":"phoneNumber","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationPAAE17startPasswordless11phoneNumber4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","role":"symbol","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","title":"startPasswordless(phoneNumber:type:connection:)"},"references":{"https://auth0.com/docs/api/authentication#post-passwordless-start":{"title":"Error Responses","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","titleInlineContent":[{"type":"text","text":"Error Responses"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"},"https://auth0.com/docs/api/authentication#get-code-or-link":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","type":"link","title":"Authentication API Endpoint"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"title":"our documentation","type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-9unt":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"kind":"text","text":": "},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt","title":"startPasswordless(phoneNumber:type:connection:)","abstract":[{"type":"text","text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless"},{"type":"text","text":" "},{"type":"text","text":"login flow."}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-5azmm":{"url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm","title":"startPasswordless(phoneNumber:type:connection:)","kind":"symbol","abstract":[{"type":"text","text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless"},{"type":"text","text":" "},{"text":"login flow.","type":"text"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:)-9unt.json b/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:)-9unt.json index 6826c6d7..fa1d94e3 100644 --- a/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:)-9unt.json +++ b/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:)-9unt.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier","text":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Phone number where to send the SMS with the code or link."}],"type":"paragraph"}],"name":"phoneNumber"},{"name":"type","content":[{"inlineContent":[{"type":"text","text":"Type of passwordless authentication. Defaults to ‘code’."}],"type":"paragraph"}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"text":"Name of the passwordless connection. Defaults to ‘sms’.","type":"text"}]}]}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}]}]},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\")"," .start { print($0) }"]},{"inlineContent":[{"text":"If you have configured iOS Universal Links:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\", type: .iOSLink)"," .start { print($0) }"],"type":"codeListing"},{"content":[{"inlineContent":[{"text":"Passwordless OTP Grant ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"type":"text","text":". Check"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"reference","isActive":true},{"text":" for more information.","type":"text"}],"type":"paragraph"}],"type":"aside","name":"Requires","style":"note"}]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"required":true,"roleHeading":"Instance Method","title":"startPasswordless(phoneNumber:type:connection:)","externalID":"s:5Auth014AuthenticationP17startPasswordless11phoneNumber4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"text":"phoneNumber","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"type","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"symbolKind":"method"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"]}],"abstract":[{"type":"text","text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless"},{"type":"text","text":" "},{"text":"login flow.","type":"text"}],"kind":"symbol","defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm"]}],"references":{"https://auth0.com/docs/api/authentication#get-code-or-link":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","title":"Authentication API Endpoint"},"https://auth0.com/docs/api/authentication#post-passwordless-start":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","title":"Error Responses","titleInlineContent":[{"type":"text","text":"Error Responses"}]},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation","titleInlineContent":[{"type":"text","text":"our documentation"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-5azmm":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","title":"startPasswordless(phoneNumber:type:connection:)","role":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm","abstract":[{"text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless","type":"text"},{"text":" ","type":"text"},{"text":"login flow.","type":"text"}],"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-9unt":{"abstract":[{"text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless","type":"text"},{"type":"text","text":" "},{"type":"text","text":"login flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt","title":"startPasswordless(phoneNumber:type:connection:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless"},{"type":"text","text":" "},{"text":"login flow.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"type"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"phoneNumber","content":[{"inlineContent":[{"type":"text","text":"Phone number where to send the SMS with the code or link."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Type of passwordless authentication. Defaults to ‘code’."}]}],"name":"type"},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the passwordless connection. Defaults to ‘sms’."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request for starting the passwordless flow.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\")"," .start { print($0) }"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"text":"If you have configured iOS Universal Links:","type":"text"}]},{"type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\", type: .iOSLink)"," .start { print($0) }"],"syntax":"swift"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp","type":"codeVoice"},{"type":"text","text":". Check"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}]}],"name":"Requires","type":"aside"}]}],"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"startPasswordless","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationP17startPasswordless11phoneNumber4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","title":"startPasswordless(phoneNumber:type:connection:)","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol","required":true},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"https://auth0.com/docs/api/authentication#post-passwordless-start":{"titleInlineContent":[{"text":"Error Responses","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-passwordless-start","title":"Error Responses"},"https://auth0.com/docs/api/authentication#get-code-or-link":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link","type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-code-or-link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-9unt":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-9unt","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"kind":"text","text":": "},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt","title":"startPasswordless(phoneNumber:type:connection:)","abstract":[{"type":"text","text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless"},{"type":"text","text":" "},{"type":"text","text":"login flow."}],"required":true,"role":"symbol","defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-5azmm":{"url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm","title":"startPasswordless(phoneNumber:type:connection:)","kind":"symbol","abstract":[{"type":"text","text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless"},{"type":"text","text":" "},{"text":"login flow.","type":"text"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","type":"topic"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"titleInlineContent":[{"text":"our documentation","type":"text"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","title":"our documentation","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/url.json b/docs/data/documentation/auth0/authentication/url.json index cbda6ced..48cd6c6d 100644 --- a/docs/data/documentation/auth0/authentication/url.json +++ b/docs/data/documentation/auth0/authentication/url.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/url"]}],"sections":[],"abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"roleHeading":"Instance Property","externalID":"s:5Auth014AuthenticationP3url10Foundation3URLVvp","symbolKind":"property","title":"url","role":"symbol","modules":[{"name":"Auth0"}],"required":true,"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/url":{"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/url","title":"url","required":true,"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/url"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url","interfaceLanguage":"swift"},"sections":[],"metadata":{"roleHeading":"Instance Property","externalID":"s:5Auth014AuthenticationP3url10Foundation3URLVvp","symbolKind":"property","role":"symbol","title":"url","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"required":true},"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/url":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"url":"\/documentation\/auth0\/authentication\/url","title":"url","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"required":true,"role":"symbol"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:).json b/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:).json index 5886807e..5fc9da4c 100644 --- a/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:).json +++ b/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:).json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)"},"abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"type":"text","text":" endpoint."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth014AuthenticationP8userInfo15withAccessTokenAA7RequestVyAA04UserD0VAA0B5ErrorVGSS_tF","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withAccessToken"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","required":true,"modules":[{"name":"Auth0"}],"title":"userInfo(withAccessToken:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-user-info"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"userInfo"},{"text":"(","kind":"text"},{"text":"withAccessToken","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"accessToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo"},{"kind":"text","text":", "},{"text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"accessToken","content":[{"inlineContent":[{"type":"text","text":"Access token obtained by authenticating the user."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield user information."}]}],"kind":"content"},{"kind":"content","content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"syntax":"swift","code":["Auth0"," .authentication()"," .userInfo(withAccessToken: credentials.accessToken)"," .start { result in"," switch result {"," case .success(let user):"," print(\"Obtained user: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"https://auth0.com/docs/api/authentication#get-user-info":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#get-user-info","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-user-info"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)","role":"symbol","kind":"symbol","type":"topic","title":"userInfo(withAccessToken:)","required":true,"abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"text":" endpoint.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"kind":"text","text":"("},{"text":"withAccessToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"UserInfo","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withAccessToken","kind":"externalParam"},{"kind":"text","text":" "},{"text":"accessToken","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"UserInfo","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":", "},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Access token obtained by authenticating the user.","type":"text"}]}],"name":"accessToken"}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield user information.","type":"text"}]}]},{"kind":"content","content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"code":["Auth0"," .authentication()"," .userInfo(withAccessToken: credentials.accessToken)"," .start { result in"," switch result {"," case .success(let user):"," print(\"Obtained user: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"text":" endpoint.","type":"text"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#get-user-info"],"title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)"]}],"metadata":{"required":true,"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP8userInfo15withAccessTokenAA7RequestVyAA04UserD0VAA0B5ErrorVGSS_tF","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"userInfo","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withAccessToken"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"symbolKind":"method","role":"symbol","title":"userInfo(withAccessToken:)"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)"},"references":{"https://auth0.com/docs/api/authentication#get-user-info":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#get-user-info","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#get-user-info"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:)":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userInfo"},{"text":"(","kind":"text"},{"text":"withAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:)","abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"type":"text","text":" endpoint."}],"required":true,"type":"topic","role":"symbol","title":"userInfo(withAccessToken:)"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror.json b/docs/data/documentation/auth0/authenticationerror.json index 90c4568e..5f7d68ce 100644 --- a/docs/data/documentation/auth0/authenticationerror.json +++ b/docs/data/documentation/auth0/authenticationerror.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"roleHeading":"Structure","title":"AuthenticationError","externalID":"s:5Auth019AuthenticationErrorV"},"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)"],"title":"Initializers"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode"],"title":"Instance Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"],"generated":true,"title":"Default Implementations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP"],"title":"Conforms To","type":"conformsTo"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","interfaceLanguage":"swift"},"sections":[],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/cause":{"abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","type":"topic","title":"cause"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/code":{"abstract":[{"type":"text","text":"The code of the error as a string."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code","type":"topic","title":"code"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","url":"\/documentation\/auth0\/auth0error\/localizeddescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","type":"topic","title":"localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorTokenInvalid":{"abstract":[{"type":"text","text":"When the MFA token is invalid or expired."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorTokenInvalid"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid","type":"topic","title":"isMultifactorTokenInvalid"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorEnrollRequired":{"abstract":[{"text":"When MFA is required and the user is not enrolled.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorEnrollRequired"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired","type":"topic","title":"isMultifactorEnrollRequired"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"abstract":[],"kind":"article","role":"collectionGroup","url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","type":"topic","title":"Auth0Error Implementations"},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error","type":"unresolvable"},"https://auth0.com/docs/api/authentication#standard-error-responses":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses","type":"link","title":"Standard Error Responses","titleInlineContent":[{"text":"Standard Error Responses","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordNotStrongEnough":{"abstract":[{"text":"When the password used for signup does not match the strength requirements of the connection.","type":"text"},{"text":" ","type":"text"},{"text":"Additional information is available in the ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","isActive":true},{"text":" dictionary.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isPasswordNotStrongEnough","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","type":"topic","title":"isPasswordNotStrongEnough"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"type":"topic","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","abstract":[],"kind":"article","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","title":"Equatable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isTooManyAttempts":{"abstract":[{"text":"When the user is blocked due to too many attempts to log in.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isTooManyAttempts"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","type":"topic","title":"isTooManyAttempts"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/debugDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/debugdescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","type":"topic","title":"debugDescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isNetworkError":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isNetworkError","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isNetworkError","url":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","role":"symbol","type":"topic","abstract":[{"type":"text","text":"When the request failed due to network issues."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/init(info:statusCode:)":{"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"info","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":")"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","type":"topic","title":"init(info:statusCode:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordLeaked":{"abstract":[{"type":"text","text":"When the password used was reported to be leaked."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isPasswordLeaked"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked","type":"topic","title":"isPasswordLeaked"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRefreshTokenDeleted":{"abstract":[{"text":"When the credentials renewal fails because the user was deleted.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted","title":"isRefreshTokenDeleted","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isRefreshTokenDeleted"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidRefreshToken":{"abstract":[],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isInvalidRefreshToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","type":"topic","title":"isInvalidRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isVerificationRequired":{"abstract":[{"text":"When an additional verification step is required.","type":"text"}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isVerificationRequired","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isverificationrequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","type":"topic","title":"isVerificationRequired"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"type":"topic","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isAccessDenied":{"abstract":[{"type":"text","text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule."}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isAccessDenied","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isaccessdenied","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","type":"topic","title":"isAccessDenied"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorCodeInvalid":{"abstract":[{"text":"When the MFA code sent is invalid or expired.","type":"text"}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isMultifactorCodeInvalid","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid","type":"topic","title":"isMultifactorCodeInvalid"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/statusCode":{"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/statuscode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","type":"topic","title":"statusCode"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"abstract":[{"text":"Additional information about the error.","type":"text"}],"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"info","kind":"identifier"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/info","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"topic","title":"info"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"title":"Foundation.LocalizedError","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isLoginRequired":{"url":"\/documentation\/auth0\/authenticationerror\/isloginrequired","type":"topic","title":"isLoginRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","kind":"symbol","abstract":[{"text":"When performing Web Auth login with ","type":"text"},{"code":"prompt: \"none\"","type":"codeVoice"},{"type":"text","text":" and the Auth0 session has expired."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isLoginRequired","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordAlreadyUsed":{"abstract":[{"text":"When the password used for signup was already used before. This is reported when the Password History feature","type":"text"},{"text":" ","type":"text"},{"text":"is enabled.","type":"text"},{"type":"text","text":" "},{"text":"Additional information is available in the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},{"type":"text","text":" dictionary."}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isPasswordAlreadyUsed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed","type":"topic","title":"isPasswordAlreadyUsed"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRuleError":{"abstract":[{"type":"text","text":"When an Auth0 rule returns an error."},{"text":" ","type":"text"},{"text":"The message returned by the rule is available in ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRuleError","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isruleerror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","type":"topic","title":"isRuleError"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidCredentials":{"abstract":[{"text":"When the username and\/or password used for authentication are invalid.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidCredentials"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials","type":"topic","title":"isInvalidCredentials"}}} \ No newline at end of file +{"relationshipsSections":[{"kind":"relationships","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP"],"title":"Conforms To"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","interfaceLanguage":"swift"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses"],"title":"Related Documentation"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode"],"title":"Instance Properties"},{"generated":true,"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror"]}],"sections":[],"metadata":{"externalID":"s:5Auth019AuthenticationErrorV","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"title":"AuthenticationError","roleHeading":"Structure","role":"symbol","symbolKind":"struct","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/debugDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"debugDescription","url":"\/documentation\/auth0\/authenticationerror\/debugdescription","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordAlreadyUsed":{"abstract":[{"type":"text","text":"When the password used for signup was already used before. This is reported when the Password History feature"},{"type":"text","text":" "},{"type":"text","text":"is enabled."},{"text":" ","type":"text"},{"type":"text","text":"Additional information is available in the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"reference"},{"text":" dictionary.","type":"text"}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isPasswordAlreadyUsed","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"isPasswordAlreadyUsed","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordNotStrongEnough":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordNotStrongEnough"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"kind":"symbol","abstract":[{"type":"text","text":"When the password used for signup does not match the strength requirements of the connection."},{"type":"text","text":" "},{"type":"text","text":"Additional information is available in the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},{"type":"text","text":" dictionary."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","type":"topic","title":"isPasswordNotStrongEnough","url":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorTokenInvalid":{"abstract":[{"type":"text","text":"When the MFA token is invalid or expired."}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorTokenInvalid","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isMultifactorTokenInvalid","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorEnrollRequired":{"abstract":[{"text":"When MFA is required and the user is not enrolled.","type":"text"}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorEnrollRequired","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"isMultifactorEnrollRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","kind":"article","role":"collectionGroup","title":"Equatable Implementations","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"localizedDescription","url":"\/documentation\/auth0\/auth0error\/localizeddescription","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"url":"\/documentation\/auth0\/auth0error","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"kind":"symbol","title":"Auth0Error"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isLoginRequired":{"title":"isLoginRequired","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isLoginRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","url":"\/documentation\/auth0\/authenticationerror\/isloginrequired","abstract":[{"text":"When performing Web Auth login with ","type":"text"},{"type":"codeVoice","code":"prompt: \"none\""},{"type":"text","text":" and the Auth0 session has expired."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","abstract":[],"title":"LocalizedError Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidRefreshToken":{"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isInvalidRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","title":"isInvalidRefreshToken","url":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"title":"Auth0Error Implementations","abstract":[],"type":"topic","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/cause":{"title":"cause","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"?","kind":"text"}],"role":"symbol","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","url":"\/documentation\/auth0\/authenticationerror\/cause","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"title":"Foundation.LocalizedError","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isNetworkError":{"title":"isNetworkError","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","abstract":[{"type":"text","text":"When the request failed due to network issues."}]},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable","title":"Swift.Error"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/code":{"abstract":[{"text":"The code of the error as a string.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol","title":"code","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"url":"\/documentation\/auth0\/authenticationerror\/code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isTooManyAttempts":{"title":"isTooManyAttempts","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isTooManyAttempts","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}]},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable","title":"Swift.Equatable"},"https://auth0.com/docs/api/authentication#standard-error-responses":{"titleInlineContent":[{"text":"Standard Error Responses","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#standard-error-responses","type":"link","title":"Standard Error Responses"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isAccessDenied":{"abstract":[{"type":"text","text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule."}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isaccessdenied","title":"isAccessDenied","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isAccessDenied","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidCredentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isInvalidCredentials"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"type":"topic","abstract":[{"type":"text","text":"When the username and\/or password used for authentication are invalid."}],"role":"symbol","kind":"symbol","title":"isInvalidCredentials","url":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordLeaked":{"title":"isPasswordLeaked","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isPasswordLeaked","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked","url":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","abstract":[{"text":"When the password used was reported to be leaked.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isMultifactorRequired","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRuleError":{"title":"isRuleError","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isRuleError"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isruleerror","abstract":[{"text":"When an Auth0 rule returns an error.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The message returned by the rule is available in "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","isActive":true},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorCodeInvalid":{"title":"isMultifactorCodeInvalid","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorCodeInvalid","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid","abstract":[{"text":"When the MFA code sent is invalid or expired.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRefreshTokenDeleted":{"title":"isRefreshTokenDeleted","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","url":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted","abstract":[{"text":"When the credentials renewal fails because the user was deleted.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"kind":"symbol","abstract":[{"text":"Additional information about the error.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"topic","title":"info","url":"\/documentation\/auth0\/authenticationerror\/info"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/init(info:statusCode:)":{"title":"init(info:statusCode:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","url":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isVerificationRequired":{"title":"isVerificationRequired","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","url":"\/documentation\/auth0\/authenticationerror\/isverificationrequired","abstract":[{"text":"When an additional verification step is required.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"title":"Auth0APIError","url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/statusCode":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","role":"symbol","kind":"symbol","title":"statusCode","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/statuscode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"HTTP status code of the response."}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/!=(_:_:).json b/docs/data/documentation/auth0/authenticationerror/!=(_:_:).json index d224da16..13a551a6 100644 --- a/docs/data/documentation/auth0/authenticationerror/!=(_:_:).json +++ b/docs/data/documentation/auth0/authenticationerror/!=(_:_:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations"]]},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)"},"kind":"symbol","metadata":{"role":"symbol","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"extendedModule":"Swift","roleHeading":"Operator","symbolKind":"op","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth019AuthenticationErrorV","title":"!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"text":".","type":"text"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/!=(_:_:)":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","url":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)","kind":"symbol","abstract":[],"title":"!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"type":"topic","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","abstract":[],"kind":"article","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","title":"Equatable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Operator","role":"symbol","symbolKind":"op","extendedModule":"Swift","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth019AuthenticationErrorV","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"title":"!=(_:_:)"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations"]]},"abstract":[{"type":"text","text":"Inherited from "},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/!=(_:_:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)","kind":"symbol","title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","kind":"article","role":"collectionGroup","title":"Equatable Implementations","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/==(_:_:).json b/docs/data/documentation/auth0/authenticationerror/==(_:_:).json index 86008f4e..df0a657d 100644 --- a/docs/data/documentation/auth0/authenticationerror/==(_:_:).json +++ b/docs/data/documentation/auth0/authenticationerror/==(_:_:).json @@ -1 +1 @@ -{"metadata":{"role":"symbol","symbolKind":"op","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"==(_:_:)","roleHeading":"Operator","extendedModule":"Auth0","externalID":"s:5Auth019AuthenticationErrorV2eeoiySbAC_ACtFZ","modules":[{"name":"Auth0"}]},"abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/==(_:_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"=="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"type":"topic","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","abstract":[],"kind":"article","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","title":"Equatable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/==(_:_:)":{"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/==(_:_:)","kind":"symbol","abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"title":"==(_:_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"=="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}],"kind":"declarations"}],"kind":"symbol","metadata":{"role":"symbol","externalID":"s:5Auth019AuthenticationErrorV2eeoiySbAC_ACtFZ","roleHeading":"Operator","title":"==(_:_:)","symbolKind":"op","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"extendedModule":"Auth0"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations"]]},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)"},"abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/==(_:_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","kind":"article","role":"collectionGroup","title":"Equatable Implementations","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/==(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","kind":"symbol","role":"symbol","title":"==(_:_:)","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/auth0error-implementations.json b/docs/data/documentation/auth0/authenticationerror/auth0error-implementations.json index 1413ce14..07923ce8 100644 --- a/docs/data/documentation/auth0/authenticationerror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/authenticationerror/auth0error-implementations.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription"],"generated":true}],"metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"Auth0Error Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/auth0error-implementations"]}],"kind":"article","schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/errorDescription":{"title":"errorDescription","abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/errordescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/localizedDescription":{"title":"localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/localizeddescription","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations"},"metadata":{"roleHeading":"API Collection","role":"collectionGroup","title":"Auth0Error Implementations","modules":[{"name":"Auth0"}]},"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription"],"title":"Instance Properties"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/auth0error-implementations"]}],"sections":[],"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/localizedDescription":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","url":"\/documentation\/auth0\/authenticationerror\/localizeddescription","abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","title":"localizedDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/errorDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/errordescription","role":"symbol","title":"errorDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/cause.json b/docs/data/documentation/auth0/authenticationerror/cause.json index 96ad88c1..d065a30f 100644 --- a/docs/data/documentation/auth0/authenticationerror/cause.json +++ b/docs/data/documentation/auth0/authenticationerror/cause.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"metadata":{"roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"externalID":"s:5Auth019AuthenticationErrorV5causes0C0_pSgvp","title":"cause","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause"},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/cause"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/cause":{"abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","type":"topic","title":"cause"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/cause"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause"},"sections":[],"metadata":{"title":"cause","roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"externalID":"s:5Auth019AuthenticationErrorV5causes0C0_pSgvp"},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/cause":{"title":"cause","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"?","kind":"text"}],"role":"symbol","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","url":"\/documentation\/auth0\/authenticationerror\/cause","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/code.json b/docs/data/documentation/auth0/authenticationerror/code.json index 18309140..7d552f30 100644 --- a/docs/data/documentation/auth0/authenticationerror/code.json +++ b/docs/data/documentation/auth0/authenticationerror/code.json @@ -1 +1 @@ -{"sections":[],"abstract":[{"text":"The code of the error as a string.","type":"text"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code"},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/code"]}],"metadata":{"title":"code","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV4codeSSvp","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/code":{"abstract":[{"type":"text","text":"The code of the error as a string."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code","type":"topic","title":"code"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"code","symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV4codeSSvp"},"abstract":[{"text":"The code of the error as a string.","type":"text"}],"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/code"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/code":{"abstract":[{"text":"The code of the error as a string.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol","title":"code","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"url":"\/documentation\/auth0\/authenticationerror\/code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/debugdescription.json b/docs/data/documentation/auth0/authenticationerror/debugdescription.json index de0536b1..a7b424a4 100644 --- a/docs/data/documentation/auth0/authenticationerror/debugdescription.json +++ b/docs/data/documentation/auth0/authenticationerror/debugdescription.json @@ -1 +1 @@ -{"abstract":[{"text":"Description of the error.","type":"text"}],"sections":[],"metadata":{"title":"debugDescription","externalID":"s:5Auth019AuthenticationErrorV16debugDescriptionSSvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"role":"symbol"},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"name":"Important","content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"text":" only.","type":"text"}]}],"type":"aside","style":"important"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/debugdescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/debugDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/debugdescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","type":"topic","title":"debugDescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth019AuthenticationErrorV16debugDescriptionSSvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"symbolKind":"property","title":"debugDescription","role":"symbol","roleHeading":"Instance Property"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"style":"important","content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"type":"strong","inlineContent":[{"text":"debugging","type":"text"}]},{"text":" only.","type":"text"}]}],"type":"aside","name":"Important"}]}],"kind":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/debugdescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/debugDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"debugDescription","url":"\/documentation\/auth0\/authenticationerror\/debugdescription","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/equatable-implementations.json b/docs/data/documentation/auth0/authenticationerror/equatable-implementations.json index b1423bab..0997181a 100644 --- a/docs/data/documentation/auth0/authenticationerror/equatable-implementations.json +++ b/docs/data/documentation/auth0/authenticationerror/equatable-implementations.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"article","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","interfaceLanguage":"swift"},"metadata":{"title":"Equatable Implementations","role":"collectionGroup","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/equatable-implementations"]}],"topicSections":[{"generated":true,"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/==(_:_:)":{"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/==(_:_:)","kind":"symbol","abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"title":"==(_:_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"=="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/!=(_:_:)":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","url":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)","kind":"symbol","abstract":[],"title":"!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}}} \ No newline at end of file +{"sections":[],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)"],"title":"Operators","generated":true}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","interfaceLanguage":"swift"},"metadata":{"role":"collectionGroup","title":"Equatable Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/==(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","kind":"symbol","role":"symbol","title":"==(_:_:)","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/!=(_:_:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)","kind":"symbol","title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/errordescription.json b/docs/data/documentation/auth0/authenticationerror/errordescription.json index c7dd1a32..8f8735d7 100644 --- a/docs/data/documentation/auth0/authenticationerror/errordescription.json +++ b/docs/data/documentation/auth0/authenticationerror/errordescription.json @@ -1 +1 @@ -{"metadata":{"title":"errorDescription","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","extendedModule":"Auth0","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"symbolKind":"property"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations"]]},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}]},{"content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"name":"Important","content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"text":" only.","type":"text"}],"type":"paragraph"}],"style":"important","type":"aside"}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Description of the error.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/errorDescription":{"title":"errorDescription","abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/errordescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"abstract":[],"kind":"article","role":"collectionGroup","url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","type":"topic","title":"Auth0Error Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations"]]},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/errordescription"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"extendedModule":"Auth0","role":"symbol","modules":[{"name":"Auth0"}],"title":"errorDescription","roleHeading":"Instance Property","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","symbolKind":"property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]},{"content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"style":"important","content":[{"inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"text":" only.","type":"text"}],"type":"paragraph"}],"name":"Important","type":"aside"}],"kind":"content"}],"abstract":[{"type":"text","text":"Description of the error."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"title":"Auth0Error Implementations","abstract":[],"type":"topic","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/errorDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/errordescription","role":"symbol","title":"errorDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/failurereason.json b/docs/data/documentation/auth0/authenticationerror/failurereason.json index d15ea5b3..e22a8992 100644 --- a/docs/data/documentation/auth0/authenticationerror/failurereason.json +++ b/docs/data/documentation/auth0/authenticationerror/failurereason.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/failurereason"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","extendedModule":"Foundation","roleHeading":"Instance Property","platforms":[{"introducedAt":"8.0","beta":false,"name":"iOS","deprecated":false,"unavailable":false},{"beta":false,"deprecated":false,"unavailable":false,"name":"macOS","introducedAt":"10.10"},{"name":"tvOS","unavailable":false,"introducedAt":"9.0","deprecated":false,"beta":false},{"name":"watchOS","introducedAt":"2.0","deprecated":false,"unavailable":false,"beta":false}],"title":"failureReason","symbolKind":"property","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"type":"topic","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/failureReason":{"kind":"symbol","type":"topic","title":"failureReason","abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","url":"\/documentation\/auth0\/authenticationerror\/failurereason","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/failurereason"]}],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.failureReason","type":"codeVoice"},{"type":"text","text":"."}],"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason"},"metadata":{"extendedModule":"Foundation","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"title":"failureReason","externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","symbolKind":"property","platforms":[{"beta":false,"deprecated":false,"unavailable":false,"name":"iOS","introducedAt":"8.0"},{"unavailable":false,"introducedAt":"10.10","deprecated":false,"beta":false,"name":"macOS"},{"beta":false,"introducedAt":"9.0","unavailable":false,"name":"tvOS","deprecated":false},{"name":"watchOS","deprecated":false,"introducedAt":"2.0","beta":false,"unavailable":false}],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","roleHeading":"Instance Property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/failureReason":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","abstract":[],"title":"failureReason","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/authenticationerror\/failurereason","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","abstract":[],"title":"LocalizedError Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/helpanchor.json b/docs/data/documentation/auth0/authenticationerror/helpanchor.json index 555a1e58..2b0e03af 100644 --- a/docs/data/documentation/auth0/authenticationerror/helpanchor.json +++ b/docs/data/documentation/auth0/authenticationerror/helpanchor.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"]]},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.helpAnchor","type":"codeVoice"},{"type":"text","text":"."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"role":"symbol","platforms":[{"beta":false,"deprecated":false,"name":"iOS","introducedAt":"8.0","unavailable":false},{"deprecated":false,"unavailable":false,"introducedAt":"10.10","beta":false,"name":"macOS"},{"introducedAt":"9.0","deprecated":false,"name":"tvOS","unavailable":false,"beta":false},{"introducedAt":"2.0","deprecated":false,"name":"watchOS","unavailable":false,"beta":false}],"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","extendedModule":"Foundation","symbolKind":"property","title":"helpAnchor"},"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"type":"topic","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/helpAnchor":{"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","title":"helpAnchor","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/helpanchor"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.helpAnchor","type":"codeVoice"},{"text":".","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"platforms":[{"name":"iOS","beta":false,"deprecated":false,"introducedAt":"8.0","unavailable":false},{"name":"macOS","beta":false,"unavailable":false,"deprecated":false,"introducedAt":"10.10"},{"introducedAt":"9.0","name":"tvOS","beta":false,"deprecated":false,"unavailable":false},{"unavailable":false,"introducedAt":"2.0","name":"watchOS","beta":false,"deprecated":false}],"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","role":"symbol","extendedModule":"Foundation","title":"helpAnchor","roleHeading":"Instance Property","modules":[{"name":"Auth0","relatedModules":["Foundation"]}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"]]},"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/helpAnchor":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"helpAnchor","url":"\/documentation\/auth0\/authenticationerror\/helpanchor","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","abstract":[],"title":"LocalizedError Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/info.json b/docs/data/documentation/auth0/authenticationerror/info.json index 88569b3e..dd4a5dfb 100644 --- a/docs/data/documentation/auth0/authenticationerror/info.json +++ b/docs/data/documentation/auth0/authenticationerror/info.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV4infoSDySSypGvp","title":"info","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}],"role":"symbol","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"abstract":[{"text":"Additional information about the error.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/info"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"abstract":[{"text":"Additional information about the error.","type":"text"}],"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"info","kind":"identifier"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/info","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"topic","title":"info"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"info","externalID":"s:5Auth019AuthenticationErrorV4infoSDySSypGvp","roleHeading":"Instance Property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},"abstract":[{"type":"text","text":"Additional information about the error."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}],"languages":["swift"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/info"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"kind":"symbol","abstract":[{"text":"Additional information about the error.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"topic","title":"info","url":"\/documentation\/auth0\/authenticationerror\/info"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/init(info:statuscode:).json b/docs/data/documentation/auth0/authenticationerror/init(info:statuscode:).json index e12eb2fb..eabe9bfa 100644 --- a/docs/data/documentation/auth0/authenticationerror/init(info:statuscode:).json +++ b/docs/data/documentation/auth0/authenticationerror/init(info:statuscode:).json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"text":"info","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"JSON response from Auth0."}]}],"name":"info"},{"name":"statusCode","content":[{"inlineContent":[{"type":"text","text":"HTTP status code of the response."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A new ","type":"text"},{"code":"AuthenticationError","type":"codeVoice"},{"type":"text","text":"."}]}]}],"metadata":{"role":"symbol","externalID":"s:5Auth019AuthenticationErrorV4info10statusCodeACSDySSypG_Sitcfc","roleHeading":"Initializer","modules":[{"name":"Auth0"}],"title":"init(info:statusCode:)","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":")"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/init(info:statusCode:)":{"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"info","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":")"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","type":"topic","title":"init(info:statusCode:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"init","title":"init(info:statusCode:)","externalID":"s:5Auth019AuthenticationErrorV4info10statusCodeACSDySSypG_Sitcfc","roleHeading":"Initializer"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"info","content":[{"inlineContent":[{"text":"JSON response from Auth0.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"HTTP status code of the response."}],"type":"paragraph"}],"name":"statusCode"}]},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"A new ","type":"text"},{"type":"codeVoice","code":"AuthenticationError"},{"type":"text","text":"."}]}]}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/init(info:statusCode:)":{"title":"init(info:statusCode:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","url":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/isaccessdenied.json b/docs/data/documentation/auth0/authenticationerror/isaccessdenied.json index c122ff84..ed6290e8 100644 --- a/docs/data/documentation/auth0/authenticationerror/isaccessdenied.json +++ b/docs/data/documentation/auth0/authenticationerror/isaccessdenied.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule.","type":"text"}],"sections":[],"metadata":{"role":"symbol","externalID":"s:5Auth019AuthenticationErrorV14isAccessDeniedSbvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"isAccessDenied","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isAccessDenied","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isaccessdenied"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isAccessDenied","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isAccessDenied":{"abstract":[{"type":"text","text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule."}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isAccessDenied","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isaccessdenied","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","type":"topic","title":"isAccessDenied"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","interfaceLanguage":"swift"},"metadata":{"symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV14isAccessDeniedSbvp","role":"symbol","modules":[{"name":"Auth0"}],"title":"isAccessDenied","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isAccessDenied","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"roleHeading":"Instance Property"},"abstract":[{"type":"text","text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isAccessDenied","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isaccessdenied"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isAccessDenied":{"abstract":[{"type":"text","text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule."}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isaccessdenied","title":"isAccessDenied","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isAccessDenied","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/isinvalidcredentials.json b/docs/data/documentation/auth0/authenticationerror/isinvalidcredentials.json index e33e4150..62b11108 100644 --- a/docs/data/documentation/auth0/authenticationerror/isinvalidcredentials.json +++ b/docs/data/documentation/auth0/authenticationerror/isinvalidcredentials.json @@ -1 +1 @@ -{"metadata":{"role":"symbol","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV20isInvalidCredentialsSbvp","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isInvalidCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isInvalidCredentials"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isinvalidcredentials"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isInvalidCredentials","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"abstract":[{"text":"When the username and\/or password used for authentication are invalid.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidCredentials":{"abstract":[{"text":"When the username and\/or password used for authentication are invalid.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidCredentials"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials","type":"topic","title":"isInvalidCredentials"}}} \ No newline at end of file +{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isInvalidCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"metadata":{"externalID":"s:5Auth019AuthenticationErrorV20isInvalidCredentialsSbvp","role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidCredentials"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"isInvalidCredentials","roleHeading":"Instance Property","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isinvalidcredentials"]}],"abstract":[{"type":"text","text":"When the username and\/or password used for authentication are invalid."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidCredentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isInvalidCredentials"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"type":"topic","abstract":[{"type":"text","text":"When the username and\/or password used for authentication are invalid."}],"role":"symbol","kind":"symbol","title":"isInvalidCredentials","url":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/isinvalidrefreshtoken.json b/docs/data/documentation/auth0/authenticationerror/isinvalidrefreshtoken.json index 2da5c8ef..8e7363fb 100644 --- a/docs/data/documentation/auth0/authenticationerror/isinvalidrefreshtoken.json +++ b/docs/data/documentation/auth0/authenticationerror/isinvalidrefreshtoken.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth019AuthenticationErrorV21isInvalidRefreshTokenSbvp","symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"role":"symbol","title":"isInvalidRefreshToken","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isInvalidRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidRefreshToken":{"abstract":[],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isInvalidRefreshToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","type":"topic","title":"isInvalidRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isInvalidRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV21isInvalidRefreshTokenSbvp","title":"isInvalidRefreshToken","symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isInvalidRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","interfaceLanguage":"swift"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidRefreshToken":{"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isInvalidRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","title":"isInvalidRefreshToken","url":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/isloginrequired.json b/docs/data/documentation/auth0/authenticationerror/isloginrequired.json index e55ea32f..60fcd957 100644 --- a/docs/data/documentation/auth0/authenticationerror/isloginrequired.json +++ b/docs/data/documentation/auth0/authenticationerror/isloginrequired.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isLoginRequired"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"isLoginRequired","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV15isLoginRequiredSbvp","symbolKind":"property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isLoginRequired","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"abstract":[{"type":"text","text":"When performing Web Auth login with "},{"type":"codeVoice","code":"prompt: \"none\""},{"text":" and the Auth0 session has expired.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isloginrequired"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isLoginRequired":{"url":"\/documentation\/auth0\/authenticationerror\/isloginrequired","type":"topic","title":"isLoginRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","kind":"symbol","abstract":[{"text":"When performing Web Auth login with ","type":"text"},{"code":"prompt: \"none\"","type":"codeVoice"},{"type":"text","text":" and the Auth0 session has expired."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isLoginRequired","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isloginrequired"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"When performing Web Auth login with "},{"code":"prompt: \"none\"","type":"codeVoice"},{"text":" and the Auth0 session has expired.","type":"text"}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isLoginRequired","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isLoginRequired"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"isLoginRequired","symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV15isLoginRequiredSbvp","roleHeading":"Instance Property","role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isLoginRequired":{"title":"isLoginRequired","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isLoginRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","url":"\/documentation\/auth0\/authenticationerror\/isloginrequired","abstract":[{"text":"When performing Web Auth login with ","type":"text"},{"type":"codeVoice","code":"prompt: \"none\""},{"type":"text","text":" and the Auth0 session has expired."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/ismultifactorcodeinvalid.json b/docs/data/documentation/auth0/authenticationerror/ismultifactorcodeinvalid.json index 51b5ac23..b32dcd98 100644 --- a/docs/data/documentation/auth0/authenticationerror/ismultifactorcodeinvalid.json +++ b/docs/data/documentation/auth0/authenticationerror/ismultifactorcodeinvalid.json @@ -1 +1 @@ -{"kind":"symbol","sections":[],"metadata":{"symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV24isMultifactorCodeInvalidSbvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"isMultifactorCodeInvalid","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorCodeInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorCodeInvalid","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid","interfaceLanguage":"swift"},"abstract":[{"text":"When the MFA code sent is invalid or expired.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorCodeInvalid":{"abstract":[{"text":"When the MFA code sent is invalid or expired.","type":"text"}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isMultifactorCodeInvalid","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid","type":"topic","title":"isMultifactorCodeInvalid"}}} \ No newline at end of file +{"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isMultifactorCodeInvalid","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"isMultifactorCodeInvalid","externalID":"s:5Auth019AuthenticationErrorV24isMultifactorCodeInvalidSbvp","roleHeading":"Instance Property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"text":"When the MFA code sent is invalid or expired.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorCodeInvalid"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorCodeInvalid":{"title":"isMultifactorCodeInvalid","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorCodeInvalid","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid","abstract":[{"text":"When the MFA code sent is invalid or expired.","type":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/ismultifactorenrollrequired.json b/docs/data/documentation/auth0/authenticationerror/ismultifactorenrollrequired.json index 73053fad..659f4e4b 100644 --- a/docs/data/documentation/auth0/authenticationerror/ismultifactorenrollrequired.json +++ b/docs/data/documentation/auth0/authenticationerror/ismultifactorenrollrequired.json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorEnrollRequired","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"metadata":{"roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV27isMultifactorEnrollRequiredSbvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorEnrollRequired","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","title":"isMultifactorEnrollRequired","symbolKind":"property","modules":[{"name":"Auth0"}]},"abstract":[{"text":"When MFA is required and the user is not enrolled.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorEnrollRequired":{"abstract":[{"text":"When MFA is required and the user is not enrolled.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorEnrollRequired"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired","type":"topic","title":"isMultifactorEnrollRequired"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","abstract":[{"text":"When MFA is required and the user is not enrolled.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorEnrollRequired"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorEnrollRequired"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth019AuthenticationErrorV27isMultifactorEnrollRequiredSbvp","symbolKind":"property","title":"isMultifactorEnrollRequired","roleHeading":"Instance Property","role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorEnrollRequired":{"abstract":[{"text":"When MFA is required and the user is not enrolled.","type":"text"}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorEnrollRequired","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"isMultifactorEnrollRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/ismultifactorrequired.json b/docs/data/documentation/auth0/authenticationerror/ismultifactorrequired.json index ef1446d6..2527a5b0 100644 --- a/docs/data/documentation/auth0/authenticationerror/ismultifactorrequired.json +++ b/docs/data/documentation/auth0/authenticationerror/ismultifactorrequired.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorrequired"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","interfaceLanguage":"swift"},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","title":"isMultifactorRequired","role":"symbol","externalID":"s:5Auth019AuthenticationErrorV21isMultifactorRequiredSbvp","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","type":"topic","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},"metadata":{"role":"symbol","externalID":"s:5Auth019AuthenticationErrorV21isMultifactorRequiredSbvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"title":"isMultifactorRequired","roleHeading":"Instance Property","symbolKind":"property"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorrequired"]}],"abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isMultifactorRequired","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/ismultifactortokeninvalid.json b/docs/data/documentation/auth0/authenticationerror/ismultifactortokeninvalid.json index eac86678..359ee683 100644 --- a/docs/data/documentation/auth0/authenticationerror/ismultifactortokeninvalid.json +++ b/docs/data/documentation/auth0/authenticationerror/ismultifactortokeninvalid.json @@ -1 +1 @@ -{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"abstract":[{"text":"When the MFA token is invalid or expired.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isMultifactorTokenInvalid","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}]}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorTokenInvalid"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"isMultifactorTokenInvalid","role":"symbol","externalID":"s:5Auth019AuthenticationErrorV25isMultifactorTokenInvalidSbvp","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorTokenInvalid":{"abstract":[{"type":"text","text":"When the MFA token is invalid or expired."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorTokenInvalid"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid","type":"topic","title":"isMultifactorTokenInvalid"}}} \ No newline at end of file +{"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV25isMultifactorTokenInvalidSbvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorTokenInvalid"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"modules":[{"name":"Auth0"}],"title":"isMultifactorTokenInvalid"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid"},"abstract":[{"type":"text","text":"When the MFA token is invalid or expired."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorTokenInvalid","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorTokenInvalid":{"abstract":[{"type":"text","text":"When the MFA token is invalid or expired."}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorTokenInvalid","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isMultifactorTokenInvalid","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/isnetworkerror.json b/docs/data/documentation/auth0/authenticationerror/isnetworkerror.json index 1a23c511..6b1c4844 100644 --- a/docs/data/documentation/auth0/authenticationerror/isnetworkerror.json +++ b/docs/data/documentation/auth0/authenticationerror/isnetworkerror.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isnetworkerror"]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"type":"paragraph","inlineContent":[{"text":"Returns ","type":"text"},{"type":"codeVoice","code":"true"},{"text":" when the ","type":"text"},{"code":"URLError","type":"codeVoice"},{"type":"text","text":" code is one of the following:"}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293104-notconnectedtointernet","isActive":true,"type":"reference"}]}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293759-networkconnectionlost","isActive":true,"type":"reference"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293434-dnslookupfailed"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293460-cannotfindhost","type":"reference"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293028-cannotconnecttohost","type":"reference"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293002-timedout","isActive":true,"type":"reference"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2292893-internationalroamingoff","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293147-callisactive"}]}]}]},{"type":"paragraph","inlineContent":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"URLError"},{"type":"text","text":" is available in the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":" property.","type":"text"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError"},"abstract":[{"type":"text","text":"When the request failed due to network issues."}],"metadata":{"title":"isNetworkError","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth019AuthenticationErrorV09isNetworkC0Sbvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"symbolKind":"property"},"sections":[],"references":{"https://developer.apple.com/documentation/foundation/urlerror/2292893-internationalroamingoff":{"type":"link","titleInlineContent":[{"type":"text","text":"internationalRoamingOff"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2292893-internationalroamingoff","title":"internationalRoamingOff","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2292893-internationalroamingoff"},"https://developer.apple.com/documentation/foundation/urlerror/2293028-cannotconnecttohost":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293028-cannotconnecttohost","type":"link","title":"cannotConnectToHost","titleInlineContent":[{"text":"cannotConnectToHost","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293028-cannotconnecttohost"},"https://developer.apple.com/documentation/foundation/urlerror/2293104-notconnectedtointernet":{"type":"link","titleInlineContent":[{"type":"text","text":"notConnectedToInternet"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293104-notconnectedtointernet","title":"notConnectedToInternet","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293104-notconnectedtointernet"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isNetworkError":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isNetworkError","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isNetworkError","url":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","role":"symbol","type":"topic","abstract":[{"type":"text","text":"When the request failed due to network issues."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError","kind":"symbol"},"https://developer.apple.com/documentation/foundation/urlerror/2293002-timedout":{"type":"link","titleInlineContent":[{"text":"timedOut","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293002-timedout","title":"timedOut","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293002-timedout"},"https://developer.apple.com/documentation/foundation/urlerror/2293434-dnslookupfailed":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293434-dnslookupfailed","title":"dnsLookupFailed","type":"link","titleInlineContent":[{"type":"text","text":"dnsLookupFailed"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293434-dnslookupfailed"},"https://developer.apple.com/documentation/foundation/urlerror/2293460-cannotfindhost":{"type":"link","titleInlineContent":[{"text":"cannotFindHost","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293460-cannotfindhost","title":"cannotFindHost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293460-cannotfindhost"},"https://developer.apple.com/documentation/foundation/urlerror/2293759-networkconnectionlost":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293759-networkconnectionlost","title":"networkConnectionLost","type":"link","titleInlineContent":[{"type":"text","text":"networkConnectionLost"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293759-networkconnectionlost"},"https://developer.apple.com/documentation/foundation/urlerror/2293147-callisactive":{"type":"link","titleInlineContent":[{"text":"callIsActive","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293147-callisactive","title":"callIsActive","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293147-callisactive"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"}}} \ No newline at end of file +{"metadata":{"title":"isNetworkError","externalID":"s:5Auth019AuthenticationErrorV09isNetworkC0Sbvp","symbolKind":"property","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"role":"symbol"},"kind":"symbol","sections":[],"abstract":[{"text":"When the request failed due to network issues.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isNetworkError","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Returns "},{"type":"codeVoice","code":"true"},{"type":"text","text":" when the "},{"code":"URLError","type":"codeVoice"},{"type":"text","text":" code is one of the following:"}]},{"items":[{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293104-notconnectedtointernet","isActive":true,"type":"reference"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293759-networkconnectionlost"}]}]},{"content":[{"inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293434-dnslookupfailed","isActive":true}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293460-cannotfindhost"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293028-cannotconnecttohost","isActive":true}]}]},{"content":[{"inlineContent":[{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293002-timedout","type":"reference"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2292893-internationalroamingoff"}]}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293147-callisactive","type":"reference","isActive":true}],"type":"paragraph"}]}],"type":"unorderedList"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The underlying "},{"code":"URLError","type":"codeVoice"},{"text":" is available in the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":" property.","type":"text"}]}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isnetworkerror"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"https://developer.apple.com/documentation/foundation/urlerror/2293759-networkconnectionlost":{"titleInlineContent":[{"type":"text","text":"networkConnectionLost"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293759-networkconnectionlost","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293759-networkconnectionlost","title":"networkConnectionLost"},"https://developer.apple.com/documentation/foundation/urlerror/2292893-internationalroamingoff":{"title":"internationalRoamingOff","titleInlineContent":[{"type":"text","text":"internationalRoamingOff"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2292893-internationalroamingoff","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2292893-internationalroamingoff","type":"link"},"https://developer.apple.com/documentation/foundation/urlerror/2293460-cannotfindhost":{"titleInlineContent":[{"type":"text","text":"cannotFindHost"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293460-cannotfindhost","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293460-cannotfindhost","title":"cannotFindHost"},"https://developer.apple.com/documentation/foundation/urlerror/2293147-callisactive":{"title":"callIsActive","titleInlineContent":[{"type":"text","text":"callIsActive"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293147-callisactive","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293147-callisactive","type":"link"},"https://developer.apple.com/documentation/foundation/urlerror/2293002-timedout":{"titleInlineContent":[{"type":"text","text":"timedOut"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293002-timedout","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293002-timedout","title":"timedOut"},"https://developer.apple.com/documentation/foundation/urlerror/2293434-dnslookupfailed":{"title":"dnsLookupFailed","titleInlineContent":[{"type":"text","text":"dnsLookupFailed"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293434-dnslookupfailed","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293434-dnslookupfailed","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isNetworkError":{"title":"isNetworkError","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","abstract":[{"type":"text","text":"When the request failed due to network issues."}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"https://developer.apple.com/documentation/foundation/urlerror/2293104-notconnectedtointernet":{"titleInlineContent":[{"type":"text","text":"notConnectedToInternet"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293104-notconnectedtointernet","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293104-notconnectedtointernet","title":"notConnectedToInternet"},"https://developer.apple.com/documentation/foundation/urlerror/2293028-cannotconnecttohost":{"title":"cannotConnectToHost","titleInlineContent":[{"type":"text","text":"cannotConnectToHost"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293028-cannotconnecttohost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/2293028-cannotconnecttohost","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/ispasswordalreadyused.json b/docs/data/documentation/auth0/authenticationerror/ispasswordalreadyused.json index c19aae8b..24d14187 100644 --- a/docs/data/documentation/auth0/authenticationerror/ispasswordalreadyused.json +++ b/docs/data/documentation/auth0/authenticationerror/ispasswordalreadyused.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"When the password used for signup was already used before. This is reported when the Password History feature","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"is enabled."},{"type":"text","text":" "},{"type":"text","text":"Additional information is available in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},{"type":"text","text":" dictionary."}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordAlreadyUsed"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV21isPasswordAlreadyUsedSbvp","roleHeading":"Instance Property","title":"isPasswordAlreadyUsed","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isPasswordAlreadyUsed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"abstract":[{"text":"Additional information about the error.","type":"text"}],"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"info","kind":"identifier"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/info","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"topic","title":"info"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordAlreadyUsed":{"abstract":[{"text":"When the password used for signup was already used before. This is reported when the Password History feature","type":"text"},{"text":" ","type":"text"},{"text":"is enabled.","type":"text"},{"type":"text","text":" "},{"text":"Additional information is available in the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},{"type":"text","text":" dictionary."}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isPasswordAlreadyUsed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed","type":"topic","title":"isPasswordAlreadyUsed"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed"},"kind":"symbol","abstract":[{"text":"When the password used for signup was already used before. This is reported when the Password History feature","type":"text"},{"type":"text","text":" "},{"type":"text","text":"is enabled."},{"text":" ","type":"text"},{"type":"text","text":"Additional information is available in the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","isActive":true},{"type":"text","text":" dictionary."}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isPasswordAlreadyUsed"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","externalID":"s:5Auth019AuthenticationErrorV21isPasswordAlreadyUsedSbvp","roleHeading":"Instance Property","title":"isPasswordAlreadyUsed","symbolKind":"property"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isPasswordAlreadyUsed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordAlreadyUsed":{"abstract":[{"type":"text","text":"When the password used for signup was already used before. This is reported when the Password History feature"},{"type":"text","text":" "},{"type":"text","text":"is enabled."},{"text":" ","type":"text"},{"type":"text","text":"Additional information is available in the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"reference"},{"text":" dictionary.","type":"text"}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isPasswordAlreadyUsed","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"isPasswordAlreadyUsed","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"kind":"symbol","abstract":[{"text":"Additional information about the error.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"topic","title":"info","url":"\/documentation\/auth0\/authenticationerror\/info"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/ispasswordleaked.json b/docs/data/documentation/auth0/authenticationerror/ispasswordleaked.json index 235b3d05..dead664d 100644 --- a/docs/data/documentation/auth0/authenticationerror/ispasswordleaked.json +++ b/docs/data/documentation/auth0/authenticationerror/ispasswordleaked.json @@ -1 +1 @@ -{"kind":"symbol","metadata":{"role":"symbol","symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"isPasswordLeaked","externalID":"s:5Auth019AuthenticationErrorV16isPasswordLeakedSbvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isPasswordLeaked","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isPasswordLeaked","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordleaked"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"When the password used was reported to be leaked.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked"},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordLeaked":{"abstract":[{"type":"text","text":"When the password used was reported to be leaked."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isPasswordLeaked"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked","type":"topic","title":"isPasswordLeaked"}}} \ No newline at end of file +{"sections":[],"abstract":[{"text":"When the password used was reported to be leaked.","type":"text"}],"metadata":{"externalID":"s:5Auth019AuthenticationErrorV16isPasswordLeakedSbvp","symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isPasswordLeaked","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"roleHeading":"Instance Property","title":"isPasswordLeaked"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isPasswordLeaked","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordleaked"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordLeaked":{"title":"isPasswordLeaked","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isPasswordLeaked","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked","url":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","abstract":[{"text":"When the password used was reported to be leaked.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/ispasswordnotstrongenough.json b/docs/data/documentation/auth0/authenticationerror/ispasswordnotstrongenough.json index 403b0470..688e3df6 100644 --- a/docs/data/documentation/auth0/authenticationerror/ispasswordnotstrongenough.json +++ b/docs/data/documentation/auth0/authenticationerror/ispasswordnotstrongenough.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordNotStrongEnough"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isPasswordNotStrongEnough","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV25isPasswordNotStrongEnoughSbvp","roleHeading":"Instance Property","title":"isPasswordNotStrongEnough","role":"symbol"},"abstract":[{"type":"text","text":"When the password used for signup does not match the strength requirements of the connection."},{"type":"text","text":" "},{"type":"text","text":"Additional information is available in the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"reference"},{"text":" dictionary.","type":"text"}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"abstract":[{"text":"Additional information about the error.","type":"text"}],"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"info","kind":"identifier"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/info","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"topic","title":"info"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordNotStrongEnough":{"abstract":[{"text":"When the password used for signup does not match the strength requirements of the connection.","type":"text"},{"text":" ","type":"text"},{"text":"Additional information is available in the ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","isActive":true},{"text":" dictionary.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isPasswordNotStrongEnough","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","type":"topic","title":"isPasswordNotStrongEnough"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough"]}],"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"type":"text","text":"When the password used for signup does not match the strength requirements of the connection."},{"type":"text","text":" "},{"type":"text","text":"Additional information is available in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},{"type":"text","text":" dictionary."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isPasswordNotStrongEnough"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","interfaceLanguage":"swift"},"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordNotStrongEnough"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"isPasswordNotStrongEnough","externalID":"s:5Auth019AuthenticationErrorV25isPasswordNotStrongEnoughSbvp","roleHeading":"Instance Property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"kind":"symbol","abstract":[{"text":"Additional information about the error.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"topic","title":"info","url":"\/documentation\/auth0\/authenticationerror\/info"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordNotStrongEnough":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordNotStrongEnough"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"kind":"symbol","abstract":[{"type":"text","text":"When the password used for signup does not match the strength requirements of the connection."},{"type":"text","text":" "},{"type":"text","text":"Additional information is available in the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},{"type":"text","text":" dictionary."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","type":"topic","title":"isPasswordNotStrongEnough","url":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/isrefreshtokendeleted.json b/docs/data/documentation/auth0/authenticationerror/isrefreshtokendeleted.json index 65f89f15..b02dca51 100644 --- a/docs/data/documentation/auth0/authenticationerror/isrefreshtokendeleted.json +++ b/docs/data/documentation/auth0/authenticationerror/isrefreshtokendeleted.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV21isRefreshTokenDeletedSbvp","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"isRefreshTokenDeleted","symbolKind":"property","role":"symbol"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"isRefreshTokenDeleted"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"When the credentials renewal fails because the user was deleted.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRefreshTokenDeleted":{"abstract":[{"text":"When the credentials renewal fails because the user was deleted.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted","title":"isRefreshTokenDeleted","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isRefreshTokenDeleted"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"When the credentials renewal fails because the user was deleted.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"externalID":"s:5Auth019AuthenticationErrorV21isRefreshTokenDeletedSbvp","symbolKind":"property","roleHeading":"Instance Property","title":"isRefreshTokenDeleted","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRefreshTokenDeleted":{"title":"isRefreshTokenDeleted","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","url":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted","abstract":[{"text":"When the credentials renewal fails because the user was deleted.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/isruleerror.json b/docs/data/documentation/auth0/authenticationerror/isruleerror.json index 3a420910..741a4d59 100644 --- a/docs/data/documentation/auth0/authenticationerror/isruleerror.json +++ b/docs/data/documentation/auth0/authenticationerror/isruleerror.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"When an Auth0 rule returns an error."},{"text":" ","type":"text"},{"type":"text","text":"The message returned by the rule is available in "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"},{"type":"text","text":"."}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth019AuthenticationErrorV06isRuleC0Sbvp","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRuleError","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"isRuleError","modules":[{"name":"Auth0"}],"symbolKind":"property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRuleError","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isruleerror"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","url":"\/documentation\/auth0\/auth0error\/localizeddescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","type":"topic","title":"localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRuleError":{"abstract":[{"type":"text","text":"When an Auth0 rule returns an error."},{"text":" ","type":"text"},{"text":"The message returned by the rule is available in ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRuleError","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isruleerror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","type":"topic","title":"isRuleError"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"When an Auth0 rule returns an error."},{"type":"text","text":" "},{"type":"text","text":"The message returned by the rule is available in "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","isActive":true},{"type":"text","text":"."}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isRuleError","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","roleHeading":"Instance Property","symbolKind":"property","title":"isRuleError","externalID":"s:5Auth019AuthenticationErrorV06isRuleC0Sbvp","modules":[{"name":"Auth0"}]},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isruleerror"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isRuleError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRuleError":{"title":"isRuleError","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isRuleError"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isruleerror","abstract":[{"text":"When an Auth0 rule returns an error.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The message returned by the rule is available in "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","isActive":true},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"localizedDescription","url":"\/documentation\/auth0\/auth0error\/localizeddescription","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/istoomanyattempts.json b/docs/data/documentation/auth0/authenticationerror/istoomanyattempts.json index d57ebd0e..e010c8ea 100644 --- a/docs/data/documentation/auth0/authenticationerror/istoomanyattempts.json +++ b/docs/data/documentation/auth0/authenticationerror/istoomanyattempts.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/istoomanyattempts"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth019AuthenticationErrorV17isTooManyAttemptsSbvp","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isTooManyAttempts","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"isTooManyAttempts"},"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isTooManyAttempts","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isTooManyAttempts":{"abstract":[{"text":"When the user is blocked due to too many attempts to log in.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isTooManyAttempts"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","type":"topic","title":"isTooManyAttempts"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isTooManyAttempts","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/istoomanyattempts"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"property","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isTooManyAttempts"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"externalID":"s:5Auth019AuthenticationErrorV17isTooManyAttemptsSbvp","role":"symbol","modules":[{"name":"Auth0"}],"title":"isTooManyAttempts"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isTooManyAttempts":{"title":"isTooManyAttempts","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isTooManyAttempts","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/isverificationrequired.json b/docs/data/documentation/auth0/authenticationerror/isverificationrequired.json index 240e18de..f1437f72 100644 --- a/docs/data/documentation/auth0/authenticationerror/isverificationrequired.json +++ b/docs/data/documentation/auth0/authenticationerror/isverificationrequired.json @@ -1 +1 @@ -{"abstract":[{"text":"When an additional verification step is required.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isverificationrequired"]}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV22isVerificationRequiredSbvp","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isVerificationRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isVerificationRequired","roleHeading":"Instance Property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"isVerificationRequired","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isVerificationRequired":{"abstract":[{"text":"When an additional verification step is required.","type":"text"}],"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"isVerificationRequired","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isverificationrequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","type":"topic","title":"isVerificationRequired"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"When an additional verification step is required."}],"metadata":{"title":"isVerificationRequired","externalID":"s:5Auth019AuthenticationErrorV22isVerificationRequiredSbvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isVerificationRequired","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isverificationrequired"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isVerificationRequired":{"title":"isVerificationRequired","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","url":"\/documentation\/auth0\/authenticationerror\/isverificationrequired","abstract":[{"text":"When an additional verification step is required.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/localizeddescription.json b/docs/data/documentation/auth0/authenticationerror/localizeddescription.json index a9aaa732..0c5ed1c0 100644 --- a/docs/data/documentation/auth0/authenticationerror/localizeddescription.json +++ b/docs/data/documentation/auth0/authenticationerror/localizeddescription.json @@ -1 +1 @@ -{"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","symbolKind":"property","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","title":"localizedDescription","role":"symbol","roleHeading":"Instance Property"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"name":"Important","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"text":" only.","type":"text"}]}],"style":"important"}]}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations"]]},"abstract":[{"text":"Description of the error.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/localizedDescription":{"title":"localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/localizeddescription","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"abstract":[],"kind":"article","role":"collectionGroup","url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","type":"topic","title":"Auth0Error Implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"text":"Description of the error.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations"]]},"kind":"symbol","sections":[],"metadata":{"role":"symbol","title":"localizedDescription","roleHeading":"Instance Property","extendedModule":"Auth0","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]},{"content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"name":"Important","content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"text":"debugging","type":"text"}]},{"text":" only.","type":"text"}],"type":"paragraph"}],"type":"aside","style":"important"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"title":"Auth0Error Implementations","abstract":[],"type":"topic","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/localizedDescription":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","url":"\/documentation\/auth0\/authenticationerror\/localizeddescription","abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","title":"localizedDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/localizederror-implementations.json b/docs/data/documentation/auth0/authenticationerror/localizederror-implementations.json index a34cf0ad..3b3867eb 100644 --- a/docs/data/documentation/auth0/authenticationerror/localizederror-implementations.json +++ b/docs/data/documentation/auth0/authenticationerror/localizederror-implementations.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"role":"collectionGroup","title":"LocalizedError Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/localizederror-implementations"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion"],"generated":true,"title":"Instance Properties"}],"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/recoverySuggestion":{"abstract":[],"url":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","title":"recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/failureReason":{"kind":"symbol","type":"topic","title":"failureReason","abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","url":"\/documentation\/auth0\/authenticationerror\/failurereason","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/helpAnchor":{"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","title":"helpAnchor","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/helpanchor"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"roleHeading":"API Collection","title":"LocalizedError Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}]},"topicSections":[{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/localizederror-implementations"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"},"kind":"article","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/failureReason":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","abstract":[],"title":"failureReason","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/authenticationerror\/failurereason","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/helpAnchor":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"helpAnchor","url":"\/documentation\/auth0\/authenticationerror\/helpanchor","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/recoverySuggestion":{"title":"recoverySuggestion","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","abstract":[]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/recoverysuggestion.json b/docs/data/documentation/auth0/authenticationerror/recoverysuggestion.json index c73c9eb5..027281d9 100644 --- a/docs/data/documentation/auth0/authenticationerror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/authenticationerror/recoverysuggestion.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/recoverysuggestion"]}],"metadata":{"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","roleHeading":"Instance Property","platforms":[{"introducedAt":"8.0","name":"iOS","deprecated":false,"unavailable":false,"beta":false},{"deprecated":false,"name":"macOS","unavailable":false,"introducedAt":"10.10","beta":false},{"beta":false,"deprecated":false,"name":"tvOS","introducedAt":"9.0","unavailable":false},{"introducedAt":"2.0","beta":false,"name":"watchOS","deprecated":false,"unavailable":false}],"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"extendedModule":"Foundation","role":"symbol","title":"recoverySuggestion","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.recoverySuggestion"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"type":"topic","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/recoverySuggestion":{"abstract":[],"url":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","title":"recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"roleHeading":"Instance Property","externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"recoverySuggestion","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"extendedModule":"Foundation","platforms":[{"unavailable":false,"introducedAt":"8.0","deprecated":false,"beta":false,"name":"iOS"},{"introducedAt":"10.10","name":"macOS","deprecated":false,"beta":false,"unavailable":false},{"deprecated":false,"beta":false,"name":"tvOS","unavailable":false,"introducedAt":"9.0"},{"unavailable":false,"beta":false,"deprecated":false,"introducedAt":"2.0","name":"watchOS"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"]]},"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"type":"text","text":"."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/recoverySuggestion":{"title":"recoverySuggestion","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","abstract":[],"title":"LocalizedError Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/statuscode.json b/docs/data/documentation/auth0/authenticationerror/statuscode.json index ae795199..0e4759f7 100644 --- a/docs/data/documentation/auth0/authenticationerror/statuscode.json +++ b/docs/data/documentation/auth0/authenticationerror/statuscode.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode"},"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/statuscode"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV10statusCodeSivp","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"statusCode"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"roleHeading":"Instance Property","symbolKind":"property","title":"statusCode","role":"symbol"},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/statusCode":{"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/statuscode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","type":"topic","title":"statusCode"}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"symbolKind":"property","roleHeading":"Instance Property","title":"statusCode","externalID":"s:5Auth019AuthenticationErrorV10statusCodeSivp"},"kind":"symbol","sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/statuscode"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/statusCode":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","role":"symbol","kind":"symbol","title":"statusCode","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/statuscode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"abstract":[{"type":"text","text":"HTTP status code of the response."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationresult.json b/docs/data/documentation/auth0/authenticationresult.json index 1ccd50e7..9af24ad2 100644 --- a/docs/data/documentation/auth0/authenticationresult.json +++ b/docs/data/documentation/auth0/authenticationresult.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"AuthenticationResult","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":"> = ","kind":"text"},{"preciseIdentifier":"s:s6ResultO","text":"Result","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth020AuthenticationResulta1Txmfp"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/authenticationresult"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","interfaceLanguage":"swift"},"abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Authentication API operations.","type":"text"}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"roleHeading":"Type Alias","title":"AuthenticationResult","modules":[{"name":"Auth0"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationResult","kind":"identifier"}],"externalID":"s:5Auth020AuthenticationResulta","role":"symbol","symbolKind":"typealias","navigatorTitle":[{"kind":"identifier","text":"AuthenticationResult"}]},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationResult":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"AuthenticationResult","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationResult"}],"abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Authentication API operations.","type":"text"}],"url":"\/documentation\/auth0\/authenticationresult","title":"AuthenticationResult","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"}}} \ No newline at end of file +{"abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Authentication API operations.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationResult"},{"kind":"text","text":"<"},{"text":"T","kind":"genericParameter"},{"kind":"text","text":"> = "},{"text":"Result","kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO"},{"text":"<","kind":"text"},{"text":"T","preciseIdentifier":"s:5Auth020AuthenticationResulta1Txmfp","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationresult"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"externalID":"s:5Auth020AuthenticationResulta","role":"symbol","roleHeading":"Type Alias","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"AuthenticationResult","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationResult","kind":"identifier"}],"title":"AuthenticationResult","symbolKind":"typealias","modules":[{"name":"Auth0"}]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationResult":{"abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Authentication API operations."}],"navigatorTitle":[{"text":"AuthenticationResult","kind":"identifier"}],"kind":"symbol","title":"AuthenticationResult","type":"topic","role":"symbol","url":"\/documentation\/auth0\/authenticationresult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationResult"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/challenge.json b/docs/data/documentation/auth0/challenge.json index 4a66332d..ef1ee7ce 100644 --- a/docs/data/documentation/auth0/challenge.json +++ b/docs/data/documentation/auth0/challenge.json @@ -1 +1 @@ -{"kind":"symbol","metadata":{"symbolKind":"struct","roleHeading":"Structure","role":"symbol","externalID":"s:5Auth09ChallengeV","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Challenge","kind":"identifier"}],"modules":[{"name":"Auth0"}],"title":"Challenge","navigatorTitle":[{"text":"Challenge","kind":"identifier"}]},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode"],"title":"Instance Properties"}],"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"type":"conformsTo"}],"abstract":[{"text":"A multi-factor challenge.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Challenge"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/auth0\/challenge"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/challengeType":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"challengeType"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"abstract":[{"text":"How the user will get the challenge and prove possession.","type":"text"}],"title":"challengeType","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","role":"symbol","url":"\/documentation\/auth0\/challenge\/challengetype"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/bindingMethod":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"bindingMethod","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/challenge\/bindingmethod","abstract":[{"text":"When the challenge response includes a ","type":"text"},{"code":"prompt","type":"codeVoice"},{"text":" binding method, your app needs to prompt the user for the","type":"text"},{"type":"text","text":" "},{"type":"codeVoice","code":"binding_code"},{"type":"text","text":" and send it as part of the request."}],"role":"symbol","title":"bindingMethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","type":"topic"},"doc://com.auth0.Auth0/SE":{"identifier":"doc:\/\/com.auth0.Auth0\/SE","type":"unresolvable","title":"Swift.Encodable"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A multi-factor challenge."}],"url":"\/documentation\/auth0\/challenge","title":"Challenge","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/init(from:)":{"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"url":"\/documentation\/auth0\/challenge\/init(from:)","abstract":[],"role":"symbol","title":"init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)","type":"topic"},"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/oobCode":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","abstract":[{"text":"Out-of-Band (OOB) code.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/challenge\/oobcode","role":"symbol","title":"oobCode","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"oobCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}}} \ No newline at end of file +{"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"role":"symbol","symbolKind":"struct","roleHeading":"Structure","modules":[{"name":"Auth0"}],"externalID":"s:5Auth09ChallengeV","title":"Challenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Challenge","kind":"identifier"}],"navigatorTitle":[{"text":"Challenge","kind":"identifier"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A multi-factor challenge."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge"]}],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode"],"title":"Instance Properties"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"kind":"relationships","type":"conformsTo","title":"Conforms To"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Challenge"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","role":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","kind":"symbol","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/challengeType":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"challengeType","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","abstract":[{"type":"text","text":"How the user will get the challenge and prove possession."}],"url":"\/documentation\/auth0\/challenge\/challengetype","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","type":"topic","title":"challengeType"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/init(from:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","url":"\/documentation\/auth0\/challenge\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/oobCode":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","abstract":[{"type":"text","text":"Out-of-Band (OOB) code."}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"oobCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"title":"oobCode","url":"\/documentation\/auth0\/challenge\/oobcode"},"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/bindingMethod":{"role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/challenge\/bindingmethod","abstract":[{"type":"text","text":"When the challenge response includes a "},{"code":"prompt","type":"codeVoice"},{"text":" binding method, your app needs to prompt the user for the","type":"text"},{"type":"text","text":" "},{"type":"codeVoice","code":"binding_code"},{"type":"text","text":" and send it as part of the request."}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"bindingMethod","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"title":"bindingMethod","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod"},"doc://com.auth0.Auth0/SE":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SE","title":"Swift.Encodable"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/challenge/bindingmethod.json b/docs/data/documentation/auth0/challenge/bindingmethod.json index ea0b7724..acb39d86 100644 --- a/docs/data/documentation/auth0/challenge/bindingmethod.json +++ b/docs/data/documentation/auth0/challenge/bindingmethod.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"bindingMethod","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"variants":[{"paths":["\/documentation\/auth0\/challenge\/bindingmethod"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"When the challenge response includes a "},{"code":"prompt","type":"codeVoice"},{"type":"text","text":" binding method, your app needs to prompt the user for the"},{"type":"text","text":" "},{"code":"binding_code","type":"codeVoice"},{"text":" and send it as part of the request.","type":"text"}],"metadata":{"role":"symbol","externalID":"s:5Auth09ChallengeV13bindingMethodSSSgvp","title":"bindingMethod","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"bindingMethod"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A multi-factor challenge."}],"url":"\/documentation\/auth0\/challenge","title":"Challenge","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/bindingMethod":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"bindingMethod","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/challenge\/bindingmethod","abstract":[{"text":"When the challenge response includes a ","type":"text"},{"code":"prompt","type":"codeVoice"},{"text":" binding method, your app needs to prompt the user for the","type":"text"},{"type":"text","text":" "},{"type":"codeVoice","code":"binding_code"},{"type":"text","text":" and send it as part of the request."}],"role":"symbol","title":"bindingMethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","type":"topic"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"When the challenge response includes a "},{"code":"prompt","type":"codeVoice"},{"type":"text","text":" binding method, your app needs to prompt the user for the"},{"type":"text","text":" "},{"type":"codeVoice","code":"binding_code"},{"type":"text","text":" and send it as part of the request."}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"metadata":{"title":"bindingMethod","role":"symbol","externalID":"s:5Auth09ChallengeV13bindingMethodSSSgvp","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"bindingMethod"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"bindingMethod"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/challenge\/bindingmethod"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","role":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","kind":"symbol","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/bindingMethod":{"role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/challenge\/bindingmethod","abstract":[{"type":"text","text":"When the challenge response includes a "},{"code":"prompt","type":"codeVoice"},{"text":" binding method, your app needs to prompt the user for the","type":"text"},{"type":"text","text":" "},{"type":"codeVoice","code":"binding_code"},{"type":"text","text":" and send it as part of the request."}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"bindingMethod","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"title":"bindingMethod","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/challenge/challengetype.json b/docs/data/documentation/auth0/challenge/challengetype.json index 787d3824..2efef519 100644 --- a/docs/data/documentation/auth0/challenge/challengetype.json +++ b/docs/data/documentation/auth0/challenge/challengetype.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth09ChallengeV13challengeTypeSSvp","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeType","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"challengeType","modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","abstract":[{"type":"text","text":"How the user will get the challenge and prove possession."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge\/challengetype"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"challengeType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge/challengeType":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"challengeType"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"abstract":[{"text":"How the user will get the challenge and prove possession.","type":"text"}],"title":"challengeType","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","role":"symbol","url":"\/documentation\/auth0\/challenge\/challengetype"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A multi-factor challenge."}],"url":"\/documentation\/auth0\/challenge","title":"Challenge","role":"symbol","type":"topic"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"platforms":["iOS"],"languages":["swift"]}]}],"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"How the user will get the challenge and prove possession."}],"variants":[{"paths":["\/documentation\/auth0\/challenge\/challengetype"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth09ChallengeV13challengeTypeSSvp","modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","title":"challengeType","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"challengeType","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","role":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","kind":"symbol","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/challengeType":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"challengeType","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","abstract":[{"type":"text","text":"How the user will get the challenge and prove possession."}],"url":"\/documentation\/auth0\/challenge\/challengetype","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","type":"topic","title":"challengeType"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/challenge/init(from:).json b/docs/data/documentation/auth0/challenge/init(from:).json index 5fc04400..a16dc201 100644 --- a/docs/data/documentation/auth0/challenge/init(from:).json +++ b/docs/data/documentation/auth0/challenge/init(from:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge\/init(from:)"]}],"kind":"symbol","abstract":[{"type":"text","text":"Inherited from "},{"code":"Decodable.init(from:)","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"title":"init(from:)","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"roleHeading":"Initializer","externalID":"s:5Auth09ChallengeV4fromACs7Decoder_p_tKcfc","symbolKind":"init"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge/init(from:)":{"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"url":"\/documentation\/auth0\/challenge\/init(from:)","abstract":[],"role":"symbol","title":"init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A multi-factor challenge."}],"url":"\/documentation\/auth0\/challenge","title":"Challenge","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"kind":"text","text":" "},{"text":"decoder","kind":"internalParam"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"languages":["swift"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"sections":[],"metadata":{"fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"externalID":"s:5Auth09ChallengeV4fromACs7Decoder_p_tKcfc","role":"symbol","symbolKind":"init","modules":[{"name":"Auth0"}],"title":"init(from:)","roleHeading":"Initializer"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge\/init(from:)"]}],"kind":"symbol","abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge/init(from:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","url":"\/documentation\/auth0\/challenge\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","role":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","kind":"symbol","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/challenge/oobcode.json b/docs/data/documentation/auth0/challenge/oobcode.json index 46b0cd8f..5a7c588c 100644 --- a/docs/data/documentation/auth0/challenge/oobcode.json +++ b/docs/data/documentation/auth0/challenge/oobcode.json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Out-of-Band (OOB) code."}],"metadata":{"title":"oobCode","modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"oobCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","externalID":"s:5Auth09ChallengeV7oobCodeSSSgvp"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"oobCode","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/challenge\/oobcode"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Challenge"}],"navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A multi-factor challenge."}],"url":"\/documentation\/auth0\/challenge","title":"Challenge","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/oobCode":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","abstract":[{"text":"Out-of-Band (OOB) code.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/challenge\/oobcode","role":"symbol","title":"oobCode","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"oobCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"metadata":{"role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"oobCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","externalID":"s:5Auth09ChallengeV7oobCodeSSSgvp","modules":[{"name":"Auth0"}],"title":"oobCode"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge\/oobcode"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"oobCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Out-of-Band (OOB) code."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"type":"topic","role":"symbol","abstract":[{"text":"A multi-factor challenge.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Challenge","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Challenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","kind":"symbol","url":"\/documentation\/auth0\/challenge","title":"Challenge"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/oobCode":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","abstract":[{"type":"text","text":"Out-of-Band (OOB) code."}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"oobCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"title":"oobCode","url":"\/documentation\/auth0\/challenge\/oobcode"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials.json b/docs/data/documentation/auth0/credentials.json index ab0b03d6..2899560a 100644 --- a/docs/data/documentation/auth0/credentials.json +++ b/docs/data/documentation/auth0/credentials.json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"@objc","kind":"attribute"},{"text":"(A0Credentials) ","kind":"text"},{"kind":"keyword","text":"final"},{"kind":"text","text":" "},{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Credentials"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"metadata":{"roleHeading":"Class","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"title":"Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"modules":[{"name":"Auth0"}],"externalID":"c:@M@Auth0@objc(cs)A0Credentials","symbolKind":"class","role":"symbol"},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)"]},{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType"]},{"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations"],"generated":true}],"relationshipsSections":[{"title":"Inherits From","type":"inheritsFrom","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/objc(cs)NSObject"]},{"type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/objc(pl)NSCoding","doc:\/\/com.auth0.Auth0\/objc(pl)NSSecureCoding","doc:\/\/com.auth0.Auth0\/objc(pl)NSObject","doc:\/\/com.auth0.Auth0\/s7CVarArgP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/SH"],"title":"Conforms To"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","role":"collectionGroup","kind":"article","title":"NSCoding Implementations","type":"topic","url":"\/documentation\/auth0\/credentials\/nscoding-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/description":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"description","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","type":"topic","url":"\/documentation\/auth0\/credentials\/description","abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"code":"","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"expiresIn","kind":"identifier"},{"kind":"text","text":": "},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","kind":"symbol","url":"\/documentation\/auth0\/credentials\/expiresin","type":"topic","title":"expiresIn","abstract":[{"type":"text","text":"When the access token expires."}]},"doc://com.auth0.Auth0/objc(cs)NSObject":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/objc(cs)NSObject","title":"ObjectiveC.NSObject"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/Decodable-Implementations":{"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations","kind":"article","url":"\/documentation\/auth0\/credentials\/decodable-implementations","type":"topic","title":"Decodable Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/accessToken":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","title":"accessToken","abstract":[{"text":"Token that can be used to make authenticated requests to the specified API (the ","type":"text"},{"inlineContent":[{"text":"audience","type":"text"}],"type":"strong"},{"text":" value used on login).","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"accessToken"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/credentials\/accesstoken","type":"topic","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSSecureCoding-Implementations":{"role":"collectionGroup","url":"\/documentation\/auth0\/credentials\/nssecurecoding-implementations","abstract":[],"type":"topic","kind":"article","title":"NSSecureCoding Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations"},"doc://com.auth0.Auth0/SH":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SH","title":"Swift.Hashable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable"},"doc://com.auth0.Auth0/objc(pl)NSObject":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSObject","title":"ObjectiveC.NSObjectProtocol"},"doc://com.auth0.Auth0/objc(pl)NSCoding":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSCoding","title":"Foundation.NSCoding"},"doc://com.auth0.Auth0/SE":{"identifier":"doc:\/\/com.auth0.Auth0\/SE","title":"Swift.Encodable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","role":"symbol","title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","abstract":[{"type":"text","text":"Default initializer."}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"idToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"expiresIn"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"recoveryCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?)","kind":"text"}]},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible","type":"unresolvable"},"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP","title":"Swift.CustomStringConvertible","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/refreshToken":{"type":"topic","title":"refreshToken","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"refreshToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Token that can be used to request a new access token."}],"url":"\/documentation\/auth0\/credentials\/refreshtoken","role":"symbol"},"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://com.auth0.Auth0/objc(pl)NSSecureCoding":{"identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSSecureCoding","title":"Foundation.NSSecureCoding","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"abstract":[{"text":"Type of the access token.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentials\/tokentype","title":"tokenType","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol"},"doc://com.auth0.Auth0/s7CVarArgP":{"identifier":"doc:\/\/com.auth0.Auth0\/s7CVarArgP","title":"Swift.CVarArg","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"abstract":[{"text":"MFA recovery code that the application must display to the user, to be stored securely for future use.","type":"text"}],"url":"\/documentation\/auth0\/credentials\/recoverycode","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","title":"recoveryCode"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/scope":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"scope"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/credentials\/scope","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"title":"scope","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/idToken":{"url":"\/documentation\/auth0\/credentials\/idtoken","role":"symbol","kind":"symbol","type":"topic","title":"idToken","abstract":[{"type":"text","text":"Token that contains the user information."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"idToken"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","interfaceLanguage":"swift"},"metadata":{"externalID":"c:@M@Auth0@objc(cs)A0Credentials","roleHeading":"Class","role":"symbol","symbolKind":"class","modules":[{"name":"Auth0"}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Credentials"}],"navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"variants":[{"paths":["\/documentation\/auth0\/credentials"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"attribute","text":"@objc"},{"kind":"text","text":"(A0Credentials) "},{"text":"final","kind":"keyword"},{"kind":"text","text":" "},{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"sections":[],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)"],"title":"Initializers"},{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType"]},{"generated":true,"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations"]}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/objc(cs)NSObject"],"kind":"relationships","type":"inheritsFrom","title":"Inherits From"},{"kind":"relationships","title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/objc(pl)NSCoding","doc:\/\/com.auth0.Auth0\/objc(pl)NSSecureCoding","doc:\/\/com.auth0.Auth0\/objc(pl)NSObject","doc:\/\/com.auth0.Auth0\/s7CVarArgP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/SH"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/refreshToken":{"abstract":[{"text":"Token that can be used to request a new access token.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","url":"\/documentation\/auth0\/credentials\/refreshtoken","title":"refreshToken","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/accessToken":{"title":"accessToken","url":"\/documentation\/auth0\/credentials\/accesstoken","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"accessToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","role":"symbol","abstract":[{"type":"text","text":"Token that can be used to make authenticated requests to the specified API (the "},{"inlineContent":[{"text":"audience","type":"text"}],"type":"strong"},{"text":" value used on login).","type":"text"}]},"doc://com.auth0.Auth0/objc(pl)NSObject":{"type":"unresolvable","title":"ObjectiveC.NSObjectProtocol","identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSObject"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"url":"\/documentation\/auth0\/credentials\/tokentype","kind":"symbol","role":"symbol","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"type":"text","text":"Type of the access token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","title":"tokenType"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"abstract":[{"type":"text","text":"MFA recovery code that the application must display to the user, to be stored securely for future use."}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoveryCode","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"recoveryCode","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentials\/recoverycode"},"doc://com.auth0.Auth0/objc(cs)NSObject":{"type":"unresolvable","title":"ObjectiveC.NSObject","identifier":"doc:\/\/com.auth0.Auth0\/objc(cs)NSObject"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/s7CVarArgP":{"type":"unresolvable","title":"Swift.CVarArg","identifier":"doc:\/\/com.auth0.Auth0\/s7CVarArgP"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"title":"NSCoding Implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","kind":"article","url":"\/documentation\/auth0\/credentials\/nscoding-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"abstract":[{"text":"When the access token expires.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/expiresin","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","kind":"symbol","title":"expiresIn"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/scope":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope","title":"scope","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"url":"\/documentation\/auth0\/credentials\/scope","role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/com.auth0.Auth0\/SE"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)":{"abstract":[{"text":"Default initializer.","type":"text"}],"type":"topic","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"idToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"expiresIn","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"recoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?)","kind":"text"}],"title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/description":{"title":"description","type":"topic","abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"code":"","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials\/description","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"description"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description"},"doc://com.auth0.Auth0/objc(pl)NSSecureCoding":{"type":"unresolvable","title":"Foundation.NSSecureCoding","identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSSecureCoding"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSSecureCoding-Implementations":{"url":"\/documentation\/auth0\/credentials\/nssecurecoding-implementations","kind":"article","type":"topic","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations","title":"NSSecureCoding Implementations"},"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"type":"unresolvable","title":"Swift.CustomStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP"},"doc://com.auth0.Auth0/objc(pl)NSCoding":{"type":"unresolvable","title":"Foundation.NSCoding","identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSCoding"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/Decodable-Implementations":{"role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations","abstract":[],"type":"topic","title":"Decodable Implementations","kind":"article","url":"\/documentation\/auth0\/credentials\/decodable-implementations"},"doc://com.auth0.Auth0/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/com.auth0.Auth0\/SH"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/idToken":{"role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/credentials\/idtoken","abstract":[{"type":"text","text":"Token that contains the user information."}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"idToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"idToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/accesstoken.json b/docs/data/documentation/auth0/credentials/accesstoken.json index 5a63a6db..8ff93485 100644 --- a/docs/data/documentation/auth0/credentials/accesstoken.json +++ b/docs/data/documentation/auth0/credentials/accesstoken.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"accessToken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"externalID":"s:5Auth011CredentialsC11accessTokenSSvp","role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/credentials\/accesstoken"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken"},"abstract":[{"type":"text","text":"Token that can be used to make authenticated requests to the specified API (the "},{"type":"strong","inlineContent":[{"text":"audience","type":"text"}]},{"text":" value used on login).","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens","https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"],"title":"Related Documentation"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/secure/tokens/access-tokens":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens","titleInlineContent":[{"type":"text","text":"Access Tokens"}],"title":"Access Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens"},"https://auth0.com/docs/secure/tokens/access-tokens/get-access-tokens#control-access-token-audience":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","titleInlineContent":[{"type":"text","text":"Audience"}],"title":"Audience","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/accessToken":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","title":"accessToken","abstract":[{"text":"Token that can be used to make authenticated requests to the specified API (the ","type":"text"},{"inlineContent":[{"text":"audience","type":"text"}],"type":"strong"},{"text":" value used on login).","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"accessToken"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/credentials\/accesstoken","type":"topic","role":"symbol","kind":"symbol"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Token that can be used to make authenticated requests to the specified API (the "},{"type":"strong","inlineContent":[{"text":"audience","type":"text"}]},{"text":" value used on login).","type":"text"}],"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"accessToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/accesstoken"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"accessToken","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"symbolKind":"property","role":"symbol","externalID":"s:5Auth011CredentialsC11accessTokenSSvp"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens","https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/secure/tokens/access-tokens":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens","type":"link","titleInlineContent":[{"text":"Access Tokens","type":"text"}],"title":"Access Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens"},"https://auth0.com/docs/secure/tokens/access-tokens/get-access-tokens#control-access-token-audience":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","titleInlineContent":[{"type":"text","text":"Audience"}],"title":"Audience","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/accessToken":{"title":"accessToken","url":"\/documentation\/auth0\/credentials\/accesstoken","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"accessToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","role":"symbol","abstract":[{"type":"text","text":"Token that can be used to make authenticated requests to the specified API (the "},{"inlineContent":[{"text":"audience","type":"text"}],"type":"strong"},{"text":" value used on login).","type":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/decodable-implementations.json b/docs/data/documentation/auth0/credentials/decodable-implementations.json index 68983bf9..79fc8d96 100644 --- a/docs/data/documentation/auth0/credentials/decodable-implementations.json +++ b/docs/data/documentation/auth0/credentials/decodable-implementations.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"kind":"article","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/decodable-implementations"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)"],"generated":true}],"sections":[],"metadata":{"role":"collectionGroup","roleHeading":"API Collection","modules":[{"name":"Auth0"}],"title":"Decodable Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(from:)":{"url":"\/documentation\/auth0\/credentials\/init(from:)","role":"symbol","kind":"symbol","type":"topic","title":"init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)"],"generated":true,"title":"Initializers"}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/decodable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"metadata":{"title":"Decodable Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(from:)":{"title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"kind":"symbol","abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","role":"symbol","url":"\/documentation\/auth0\/credentials\/init(from:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/description.json b/docs/data/documentation/auth0/credentials/description.json index 0b16d99b..ebb04a95 100644 --- a/docs/data/documentation/auth0/credentials/description.json +++ b/docs/data/documentation/auth0/credentials/description.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"override","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}]}],"sections":[],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/description"]}],"abstract":[{"text":"Custom description that redacts the tokens with ","type":"text"},{"type":"codeVoice","code":""},{"type":"text","text":"."}],"metadata":{"externalID":"c:@M@Auth0@objc(cs)A0Credentials(py)description","roleHeading":"Instance Property","symbolKind":"property","title":"description","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"description","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/description":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"description","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","type":"topic","url":"\/documentation\/auth0\/credentials\/description","abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"code":"","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"c:@M@Auth0@objc(cs)A0Credentials(py)description","roleHeading":"Instance Property","title":"description"},"abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"type":"codeVoice","code":""},{"text":".","type":"text"}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"override","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/description"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/description":{"title":"description","type":"topic","abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"code":"","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentials\/description","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"description"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/encode(with:).json b/docs/data/documentation/auth0/credentials/encode(with:).json index 0a83f7f5..fd81be2d 100644 --- a/docs/data/documentation/auth0/credentials/encode(with:).json +++ b/docs/data/documentation/auth0/credentials/encode(with:).json @@ -1 +1 @@ -{"metadata":{"externalID":"c:@CM@Auth0@objc(cs)A0Credentials(im)encodeWithCoder:","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}],"roleHeading":"Instance Method","extendedModule":"Auth0","role":"symbol","modules":[{"name":"Auth0"}],"title":"encode(with:)","symbolKind":"method"},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations"]]},"abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"type":"text","text":" encoding method."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"aCoder","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"NSCoder","preciseIdentifier":"c:objc(cs)NSCoder"},{"kind":"text","text":")"}],"platforms":["iOS"]}]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/encode(with:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","role":"collectionGroup","kind":"article","title":"NSCoding Implementations","type":"topic","url":"\/documentation\/auth0\/credentials\/nscoding-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/encode(with:)":{"title":"encode(with:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"kind":"text","text":")"}],"url":"\/documentation\/auth0\/credentials\/encode(with:)","abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" encoding method."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" encoding method."}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/encode(with:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"c:@CM@Auth0@objc(cs)A0Credentials(im)encodeWithCoder:","roleHeading":"Instance Method","title":"encode(with:)","extendedModule":"Auth0","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NSCoder","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder"},{"text":")","kind":"text"}],"symbolKind":"method"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":" "},{"kind":"internalParam","text":"aCoder"},{"kind":"text","text":": "},{"text":"NSCoder","preciseIdentifier":"c:objc(cs)NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"title":"NSCoding Implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","kind":"article","url":"\/documentation\/auth0\/credentials\/nscoding-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/encode(with:)":{"abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" encoding method."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSCoder","kind":"typeIdentifier","text":"NSCoder"},{"kind":"text","text":")"}],"role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentials\/encode(with:)","title":"encode(with:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/expiresin.json b/docs/data/documentation/auth0/credentials/expiresin.json index c2dee0cd..97468d85 100644 --- a/docs/data/documentation/auth0/credentials/expiresin.json +++ b/docs/data/documentation/auth0/credentials/expiresin.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"When the access token expires."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"sections":[],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"expiresIn"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/expiresin"]}],"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"expiresIn"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}],"externalID":"s:5Auth011CredentialsC9expiresIn10Foundation4DateVvp","modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","role":"symbol","title":"expiresIn"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"expiresIn","kind":"identifier"},{"kind":"text","text":": "},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","kind":"symbol","url":"\/documentation\/auth0\/credentials\/expiresin","type":"topic","title":"expiresIn","abstract":[{"type":"text","text":"When the access token expires."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"expiresIn"},{"text":": ","kind":"text"},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"abstract":[{"text":"When the access token expires.","type":"text"}],"metadata":{"externalID":"s:5Auth011CredentialsC9expiresIn10Foundation4DateVvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"expiresIn"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}],"modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","symbolKind":"property","title":"expiresIn"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/expiresin"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"abstract":[{"text":"When the access token expires.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/expiresin","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","kind":"symbol","title":"expiresIn"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/idtoken.json b/docs/data/documentation/auth0/credentials/idtoken.json index 3629f456..1189fed8 100644 --- a/docs/data/documentation/auth0/credentials/idtoken.json +++ b/docs/data/documentation/auth0/credentials/idtoken.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken"},"kind":"symbol","abstract":[{"text":"Token that contains the user information.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"idToken","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"type":"aside","style":"important","name":"Important","content":[{"inlineContent":[{"type":"text","text":"The ID tokens obtained from Web Auth login are automatically validated by Auth0.swift, ensuring their"},{"type":"text","text":" "},{"text":"contents have not been tampered with. ","type":"text"},{"type":"strong","inlineContent":[{"text":"This is not the case for the ID tokens obtained from the Authentication API","type":"text"},{"text":" ","type":"text"},{"text":"client","type":"text"}]},{"type":"text","text":", including the ones received when renewing the credentials using the refresh token. You must"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","isActive":true,"type":"reference"},{"type":"text","text":" any ID tokens received from the"},{"text":" ","type":"text"},{"text":"Authentication API client before using the information they contain.","type":"text"}],"type":"paragraph"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/idtoken"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"sections":[],"metadata":{"symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"idToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"idToken","externalID":"s:5Auth011CredentialsC7idTokenSSvp"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"https://auth0.com/docs/secure/tokens/id-tokens":{"titleInlineContent":[{"text":"ID Tokens","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","type":"link","title":"ID Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/idToken":{"url":"\/documentation\/auth0\/credentials\/idtoken","role":"symbol","kind":"symbol","type":"topic","title":"idToken","abstract":[{"type":"text","text":"Token that contains the user information."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"idToken"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken"},"https://auth0.com/docs/secure/tokens/id-tokens/validate-id-tokens":{"titleInlineContent":[{"type":"text","text":"validate"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","type":"link","title":"validate","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"idToken","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"languages":["swift"]}]},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"style":"important","type":"aside","name":"Important","content":[{"type":"paragraph","inlineContent":[{"text":"The ID tokens obtained from Web Auth login are automatically validated by Auth0.swift, ensuring their","type":"text"},{"type":"text","text":" "},{"type":"text","text":"contents have not been tampered with. "},{"type":"strong","inlineContent":[{"type":"text","text":"This is not the case for the ID tokens obtained from the Authentication API"},{"text":" ","type":"text"},{"type":"text","text":"client"}]},{"text":", including the ones received when renewing the credentials using the refresh token. You must","type":"text"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","type":"reference","isActive":true},{"type":"text","text":" any ID tokens received from the"},{"text":" ","type":"text"},{"text":"Authentication API client before using the information they contain.","type":"text"}]}]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"metadata":{"role":"symbol","symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"idToken","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"title":"idToken","externalID":"s:5Auth011CredentialsC7idTokenSSvp","roleHeading":"Instance Property"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/idtoken"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Token that contains the user information.","type":"text"}],"references":{"https://auth0.com/docs/secure/tokens/id-tokens/validate-id-tokens":{"type":"link","title":"validate","titleInlineContent":[{"type":"text","text":"validate"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens"},"https://auth0.com/docs/secure/tokens/id-tokens":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","title":"ID Tokens","titleInlineContent":[{"type":"text","text":"ID Tokens"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/idToken":{"role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/credentials\/idtoken","abstract":[{"type":"text","text":"Token that contains the user information."}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"idToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"idToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:).json b/docs/data/documentation/auth0/credentials/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:).json index ffcc0ead..136b657e 100644 --- a/docs/data/documentation/auth0/credentials/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:).json +++ b/docs/data/documentation/auth0/credentials/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","interfaceLanguage":"swift"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" = \"\", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" = \"\", "},{"text":"idToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" = \"\", "},{"text":"refreshToken","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil, "},{"text":"expiresIn","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"text":" = Date(), ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"text":"recoveryCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil)"}]}]}],"metadata":{"externalID":"s:5Auth011CredentialsC11accessToken9tokenType02idD007refreshD09expiresIn5scope12recoveryCodeACSS_S3SSg10Foundation4DateVA2Ktcfc","role":"symbol","modules":[{"name":"Auth0"}],"title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"idToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"expiresIn","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"recoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?)","kind":"text"}],"roleHeading":"Initializer"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)"]}],"abstract":[{"type":"text","text":"Default initializer."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","role":"symbol","title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","abstract":[{"type":"text","text":"Default initializer."}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"idToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"expiresIn"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"recoveryCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?)","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]}}} \ No newline at end of file +{"sections":[],"metadata":{"roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"idToken","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"text":"expiresIn","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"text":"recoveryCode","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"modules":[{"name":"Auth0"}],"symbolKind":"init","role":"symbol","externalID":"s:5Auth011CredentialsC11accessToken9tokenType02idD007refreshD09expiresIn5scope12recoveryCodeACSS_S3SSg10Foundation4DateVA2Ktcfc","title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)"},"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"abstract":[{"text":"Default initializer.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" = \"\", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" = \"\", "},{"kind":"externalParam","text":"idToken"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" = \"\", ","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":" = Date(), "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"recoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil)"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)":{"abstract":[{"text":"Default initializer.","type":"text"}],"type":"topic","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"idToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"expiresIn","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"recoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?)","kind":"text"}],"title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/init(coder:).json b/docs/data/documentation/auth0/credentials/init(coder:).json index dd5124f0..f40744dc 100644 --- a/docs/data/documentation/auth0/credentials/init(coder:).json +++ b/docs/data/documentation/auth0/credentials/init(coder:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"convenience"},{"kind":"text","text":" "},{"text":"init","kind":"keyword"},{"kind":"text","text":"?("},{"text":"coder","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"aDecoder"},{"text":": ","kind":"text"},{"text":"NSCoder","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder"},{"kind":"text","text":")"}]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)"},"abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"text":" decoding initializer.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/init(coder:)"]}],"metadata":{"symbolKind":"init","externalID":"c:@CM@Auth0@objc(cs)A0Credentials(im)initWithCoder:","roleHeading":"Initializer","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"text":"coder","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder"},{"kind":"text","text":")"}],"title":"init(coder:)","extendedModule":"Auth0"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(coder:)":{"title":"init(coder:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","type":"topic","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"coder"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/credentials\/init(coder:)","kind":"symbol","abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"type":"text","text":" decoding initializer."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","role":"collectionGroup","kind":"article","title":"NSCoding Implementations","type":"topic","url":"\/documentation\/auth0\/credentials\/nscoding-implementations"}}} \ No newline at end of file +{"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/credentials\/init(coder:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)"},"abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"text":" decoding initializer.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"convenience"},{"text":" ","kind":"text"},{"text":"init","kind":"keyword"},{"kind":"text","text":"?("},{"text":"coder","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"aDecoder","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}]}],"kind":"declarations"}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"symbolKind":"init","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"coder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder"},{"text":")","kind":"text"}],"externalID":"c:@CM@Auth0@objc(cs)A0Credentials(im)initWithCoder:","title":"init(coder:)","roleHeading":"Initializer","extendedModule":"Auth0"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"title":"NSCoding Implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","kind":"article","url":"\/documentation\/auth0\/credentials\/nscoding-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(coder:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"text":"coder","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NSCoder","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder"},{"kind":"text","text":")"}],"role":"symbol","type":"topic","title":"init(coder:)","kind":"symbol","url":"\/documentation\/auth0\/credentials\/init(coder:)","abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"type":"text","text":" decoding initializer."}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/init(from:).json b/docs/data/documentation/auth0/credentials/init(from:).json index 3d3eb1d3..a5c1eee8 100644 --- a/docs/data/documentation/auth0/credentials/init(from:).json +++ b/docs/data/documentation/auth0/credentials/init(from:).json @@ -1 +1 @@ -{"abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"convenience","kind":"keyword"},{"text":" ","kind":"text"},{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"platforms":["iOS"]}]}],"kind":"symbol","metadata":{"title":"init(from:)","symbolKind":"init","roleHeading":"Initializer","modules":[{"name":"Auth0"}],"externalID":"s:5Auth011CredentialsC4fromACs7Decoder_p_tKcfc","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"role":"symbol","extendedModule":"Auth0"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/init(from:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/Decodable-Implementations":{"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations","kind":"article","url":"\/documentation\/auth0\/credentials\/decodable-implementations","type":"topic","title":"Decodable Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(from:)":{"url":"\/documentation\/auth0\/credentials\/init(from:)","role":"symbol","kind":"symbol","type":"topic","title":"init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)"}}} \ No newline at end of file +{"metadata":{"role":"symbol","title":"init(from:)","extendedModule":"Auth0","symbolKind":"init","externalID":"s:5Auth011CredentialsC4fromACs7Decoder_p_tKcfc","roleHeading":"Initializer","modules":[{"name":"Auth0"}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"text":": ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"codeVoice","code":"Decodable"},{"text":" initializer.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/init(from:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"convenience"},{"text":" ","kind":"text"},{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"kind":"symbol","sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/Decodable-Implementations":{"role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations","abstract":[],"type":"topic","title":"Decodable Implementations","kind":"article","url":"\/documentation\/auth0\/credentials\/decodable-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(from:)":{"title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"kind":"symbol","abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","role":"symbol","url":"\/documentation\/auth0\/credentials\/init(from:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/nscoding-implementations.json b/docs/data/documentation/auth0/credentials/nscoding-implementations.json index 35fe5d74..c25139f9 100644 --- a/docs/data/documentation/auth0/credentials/nscoding-implementations.json +++ b/docs/data/documentation/auth0/credentials/nscoding-implementations.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"metadata":{"title":"NSCoding Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"kind":"article","topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)"],"generated":true},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)"],"title":"Instance Methods","generated":true}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/nscoding-implementations"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/encode(with:)":{"title":"encode(with:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"kind":"text","text":")"}],"url":"\/documentation\/auth0\/credentials\/encode(with:)","abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" encoding method."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(coder:)":{"title":"init(coder:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","type":"topic","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"coder"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/credentials\/init(coder:)","kind":"symbol","abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"type":"text","text":" decoding initializer."}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/nscoding-implementations"]}],"kind":"article","topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)"],"title":"Initializers"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)"],"generated":true,"title":"Instance Methods"}],"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","roleHeading":"API Collection","title":"NSCoding Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/encode(with:)":{"abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" encoding method."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSCoder","kind":"typeIdentifier","text":"NSCoder"},{"kind":"text","text":")"}],"role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentials\/encode(with:)","title":"encode(with:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(coder:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"text":"coder","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NSCoder","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder"},{"kind":"text","text":")"}],"role":"symbol","type":"topic","title":"init(coder:)","kind":"symbol","url":"\/documentation\/auth0\/credentials\/init(coder:)","abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"type":"text","text":" decoding initializer."}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/nssecurecoding-implementations.json b/docs/data/documentation/auth0/credentials/nssecurecoding-implementations.json index 98003ac9..bd6c211d 100644 --- a/docs/data/documentation/auth0/credentials/nssecurecoding-implementations.json +++ b/docs/data/documentation/auth0/credentials/nssecurecoding-implementations.json @@ -1 +1 @@ -{"topicSections":[{"title":"Type Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding"],"generated":true}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/nssecurecoding-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations","interfaceLanguage":"swift"},"kind":"article","sections":[],"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"NSSecureCoding Implementations","roleHeading":"API Collection"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/supportsSecureCoding":{"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"url":"\/documentation\/auth0\/credentials\/supportssecurecoding","abstract":[{"type":"text","text":"Property that enables secure coding. Equals to "},{"type":"codeVoice","code":"true"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","title":"supportsSecureCoding","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/nssecurecoding-implementations"]}],"sections":[],"topicSections":[{"generated":true,"title":"Type Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations"},"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"NSSecureCoding Implementations","role":"collectionGroup","roleHeading":"API Collection"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/supportsSecureCoding":{"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"supportsSecureCoding"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","title":"supportsSecureCoding","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding","url":"\/documentation\/auth0\/credentials\/supportssecurecoding","role":"symbol","abstract":[{"type":"text","text":"Property that enables secure coding. Equals to "},{"code":"true","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/recoverycode.json b/docs/data/documentation/auth0/credentials/recoverycode.json index 98e9ff32..fb38d906 100644 --- a/docs/data/documentation/auth0/credentials/recoverycode.json +++ b/docs/data/documentation/auth0/credentials/recoverycode.json @@ -1 +1 @@ -{"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"recoveryCode","symbolKind":"property","externalID":"s:5Auth011CredentialsC12recoveryCodeSSSgvp","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"abstract":[{"text":"MFA recovery code that the application must display to the user, to be stored securely for future use.","type":"text"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"recoveryCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/recoverycode"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"abstract":[{"text":"MFA recovery code that the application must display to the user, to be stored securely for future use.","type":"text"}],"url":"\/documentation\/auth0\/credentials\/recoverycode","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","title":"recoveryCode"},"https://auth0.com/docs/secure/multi-factor-authentication/configure-recovery-codes-for-mfa":{"titleInlineContent":[{"text":"MFA Recovery Codes","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa","type":"link","url":"https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa","title":"MFA Recovery Codes"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/credentials\/recoverycode"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"MFA recovery code that the application must display to the user, to be stored securely for future use."}],"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoveryCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"title":"recoveryCode","modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","externalID":"s:5Auth011CredentialsC12recoveryCodeSSSgvp","roleHeading":"Instance Property"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa"]}],"kind":"symbol","references":{"https://auth0.com/docs/secure/multi-factor-authentication/configure-recovery-codes-for-mfa":{"title":"MFA Recovery Codes","titleInlineContent":[{"type":"text","text":"MFA Recovery Codes"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa","url":"https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"abstract":[{"type":"text","text":"MFA recovery code that the application must display to the user, to be stored securely for future use."}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoveryCode","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"recoveryCode","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentials\/recoverycode"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/refreshtoken.json b/docs/data/documentation/auth0/credentials/refreshtoken.json index 1e702e3f..0d20c518 100644 --- a/docs/data/documentation/auth0/credentials/refreshtoken.json +++ b/docs/data/documentation/auth0/credentials/refreshtoken.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/refreshtoken"]}],"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}]}]},{"content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"style":"note","type":"aside","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login. Make sure that your Auth0 application"},{"type":"text","text":" "},{"text":"has the ","type":"text"},{"inlineContent":[{"type":"text","text":"refresh token"}],"type":"strong"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types","isActive":true,"type":"reference"},{"type":"text","text":"."},{"text":" ","type":"text"},{"type":"text","text":"If you are also specifying an audience value, make sure that the corresponding Auth0 API has the"},{"text":" ","type":"text"},{"inlineContent":[{"type":"text","text":"Allow Offline Access"}],"type":"strong"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings","isActive":true},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","symbolKind":"property","externalID":"s:5Auth011CredentialsC12refreshTokenSSSgvp","title":"refreshToken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"abstract":[{"type":"text","text":"Token that can be used to request a new access token."}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"https://auth0.com/docs/get-started/applications/update-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types","title":"grant enabled","type":"link","titleInlineContent":[{"text":"grant enabled","type":"text"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/refreshToken":{"type":"topic","title":"refreshToken","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"refreshToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Token that can be used to request a new access token."}],"url":"\/documentation\/auth0\/credentials\/refreshtoken","role":"symbol"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens"},"https://auth0.com/docs/get-started/apis/api-settings#access-settings":{"title":"setting enabled","titleInlineContent":[{"type":"text","text":"setting enabled"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"],"title":"Related Documentation"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken"},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"refreshToken"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login. Make sure that your Auth0 application"},{"text":" ","type":"text"},{"text":"has the ","type":"text"},{"type":"strong","inlineContent":[{"text":"refresh token","type":"text"}]},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types","isActive":true},{"type":"text","text":"."},{"text":" ","type":"text"},{"type":"text","text":"If you are also specifying an audience value, make sure that the corresponding Auth0 API has the"},{"text":" ","type":"text"},{"type":"strong","inlineContent":[{"text":"Allow Offline Access","type":"text"}]},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings"},{"text":".","type":"text"}]}],"name":"Requires"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"metadata":{"role":"symbol","title":"refreshToken","externalID":"s:5Auth011CredentialsC12refreshTokenSSSgvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"refreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"abstract":[{"type":"text","text":"Token that can be used to request a new access token."}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/refreshtoken"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/refreshToken":{"abstract":[{"text":"Token that can be used to request a new access token.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","url":"\/documentation\/auth0\/credentials\/refreshtoken","title":"refreshToken","kind":"symbol","type":"topic"},"https://auth0.com/docs/get-started/applications/update-grant-types":{"type":"link","title":"grant enabled","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types","titleInlineContent":[{"type":"text","text":"grant enabled"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types"},"https://auth0.com/docs/get-started/apis/api-settings#access-settings":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings","titleInlineContent":[{"text":"setting enabled","type":"text"}],"type":"link","title":"setting enabled"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"type":"link","title":"Refresh Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/scope.json b/docs/data/documentation/auth0/credentials/scope.json index 85a6dfa7..2024565a 100644 --- a/docs/data/documentation/auth0/credentials/scope.json +++ b/docs/data/documentation/auth0/credentials/scope.json @@ -1 +1 @@ -{"abstract":[{"text":"The scopes that have been granted by Auth0.","type":"text"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"],"title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/scope"]}],"metadata":{"externalID":"s:5Auth011CredentialsC5scopeSSSgvp","role":"symbol","title":"scope","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/scope":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"scope"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/credentials\/scope","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"title":"scope","role":"symbol"},"https://auth0.com/docs/get-started/apis/scopes":{"type":"link","titleInlineContent":[{"type":"text","text":"Scopes"}],"url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","title":"Scopes","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"}}} \ No newline at end of file +{"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"]}],"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"scope","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:5Auth011CredentialsC5scopeSSSgvp","role":"symbol","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"scope","roleHeading":"Instance Property"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/scope"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/scope":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope","title":"scope","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"url":"\/documentation\/auth0\/credentials\/scope","role":"symbol","type":"topic","kind":"symbol"},"https://auth0.com/docs/get-started/apis/scopes":{"url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","title":"Scopes","type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","titleInlineContent":[{"type":"text","text":"Scopes"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/supportssecurecoding.json b/docs/data/documentation/auth0/credentials/supportssecurecoding.json index 6e0e0677..f6ff2856 100644 --- a/docs/data/documentation/auth0/credentials/supportssecurecoding.json +++ b/docs/data/documentation/auth0/credentials/supportssecurecoding.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/supportssecurecoding"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]}],"metadata":{"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"c:@CM@Auth0@objc(cs)A0Credentials(cpy)supportsSecureCoding","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"roleHeading":"Type Property","role":"symbol","title":"supportsSecureCoding","symbolKind":"property"},"abstract":[{"text":"Property that enables secure coding. Equals to ","type":"text"},{"type":"codeVoice","code":"true"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/supportsSecureCoding":{"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"url":"\/documentation\/auth0\/credentials\/supportssecurecoding","abstract":[{"type":"text","text":"Property that enables secure coding. Equals to "},{"type":"codeVoice","code":"true"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","title":"supportsSecureCoding","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSSecureCoding-Implementations":{"role":"collectionGroup","url":"\/documentation\/auth0\/credentials\/nssecurecoding-implementations","abstract":[],"type":"topic","kind":"article","title":"NSSecureCoding Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations"]]},"metadata":{"externalID":"c:@CM@Auth0@objc(cs)A0Credentials(cpy)supportsSecureCoding","roleHeading":"Type Property","extendedModule":"Auth0","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"supportsSecureCoding","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding"},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"abstract":[{"text":"Property that enables secure coding. Equals to ","type":"text"},{"type":"codeVoice","code":"true"},{"type":"text","text":"."}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentials\/supportssecurecoding"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/supportsSecureCoding":{"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"supportsSecureCoding"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","title":"supportsSecureCoding","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding","url":"\/documentation\/auth0\/credentials\/supportssecurecoding","role":"symbol","abstract":[{"type":"text","text":"Property that enables secure coding. Equals to "},{"code":"true","type":"codeVoice"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSSecureCoding-Implementations":{"url":"\/documentation\/auth0\/credentials\/nssecurecoding-implementations","kind":"article","type":"topic","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations","title":"NSSecureCoding Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials/tokentype.json b/docs/data/documentation/auth0/credentials/tokentype.json index ac2e70d1..ca331b4a 100644 --- a/docs/data/documentation/auth0/credentials/tokentype.json +++ b/docs/data/documentation/auth0/credentials/tokentype.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"tokenType"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"languages":["swift"]}]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType"},"abstract":[{"text":"Type of the access token.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/tokentype"]}],"metadata":{"externalID":"s:5Auth011CredentialsC9tokenTypeSSvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"tokenType","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"tokenType","role":"symbol","symbolKind":"property"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"abstract":[{"text":"Type of the access token.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentials\/tokentype","title":"tokenType","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol"}}} \ No newline at end of file +{"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentials\/tokentype"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"property","role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth011CredentialsC9tokenTypeSSvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"tokenType","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"modules":[{"name":"Auth0"}],"title":"tokenType"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Type of the access token.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"url":"\/documentation\/auth0\/credentials\/tokentype","kind":"symbol","role":"symbol","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"type":"text","text":"Type of the access token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","title":"tokenType"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager.json b/docs/data/documentation/auth0/credentialsmanager.json index 5325b443..d8f59afd 100644 --- a/docs/data/documentation/auth0/credentialsmanager.json +++ b/docs/data/documentation/auth0/credentialsmanager.json @@ -1 +1 @@ -{"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"anchor":"overview","type":"heading","text":"Overview"},{"style":"warning","name":"Warning","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The Credentials Manager is not thread-safe, except for its"},{"type":"text","text":" "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","type":"reference","isActive":true},{"type":"text","text":" and"},{"text":" ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","type":"reference","isActive":true},{"text":" methods. To avoid concurrency issues, do not call its","type":"text"},{"type":"text","text":" "},{"type":"text","text":"non thread-safe methods and properties from different threads without proper synchronization."}]}],"type":"aside"}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)"],"title":"Initializers"},{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)"],"title":"Instance Methods"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"externalID":"s:5Auth018CredentialsManagerV","title":"CredentialsManager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"symbolKind":"struct","role":"symbol"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-11d2f":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"}],"abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token"},{"text":" ","type":"text"},{"type":"text","text":"is expired. Otherwise, return the retrieved credentials as they are not expired. Renewed credentials will be"},{"type":"text","text":" "},{"type":"text","text":"stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","title":"credentials(withScope:minTTL:parameters:headers:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"abstract":[{"text":"Clears credentials stored in the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/clear()","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clear"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","kind":"symbol","title":"clear()","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference"},{"text":" can be accessed via the ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"text":" property.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","title":"revokeFailed","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}]},"https://auth0.com/docs/secure/tokens/id-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","titleInlineContent":[{"text":"ID token","type":"text"}],"title":"ID token","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","title":"store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-7yn20":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"text":".","type":"text"}],"type":"topic","kind":"symbol","title":"renew(parameters:headers:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hasValid","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","abstract":[{"text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within","type":"text"},{"type":"text","text":" "},{"type":"text","text":"the specified TTL. If you are not using refresh tokens, use this method instead of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","type":"reference","isActive":true},{"type":"text","text":" to"},{"text":" ","type":"text"},{"text":"check for stored credentials when your app starts up.","type":"text"}],"title":"hasValid(minTTL:)","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-3jl3m":{"abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}],"kind":"symbol","title":"renew(parameters:headers:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-6wgai":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]) "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai","type":"topic","title":"revoke(headers:)","kind":"symbol","abstract":[{"type":"text","text":"Calls the "},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint to revoke the refresh token and then clears the credentials if the request"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials are not cleared and an error is thrown.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-7xldm":{"type":"topic","abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token"},{"text":" ","type":"text"},{"type":"text","text":"is expired. Otherwise, the subscription will complete with the retrieved credentials as they are not expired."},{"type":"text","text":" "},{"type":"text","text":"Renewed credentials will be stored in the Keychain. "},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"type":"text","text":"."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"kind":"symbol","title":"credentials(withScope:minTTL:parameters:headers:)","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"canRenew","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","abstract":[{"text":"Checks that there are credentials stored, and that the credentials contain a refresh token. If you are using","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"refresh tokens, use this method instead of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","isActive":true,"type":"reference"},{"text":" to check for stored credentials when your app","type":"text"},{"text":" ","type":"text"},{"text":"starts up.","type":"text"}],"title":"canRenew()","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-9mzo6":{"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Calls the "},{"type":"codeVoice","code":"\/oauth\/revoke"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"type":"text","text":" "},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error."}],"title":"revoke(headers:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"abstract":[],"kind":"article","url":"\/documentation\/auth0\/refreshtokens","title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:callback:)":{"title":"credentials(withScope:minTTL:parameters:headers:callback:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","kind":"symbol","abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token"},{"type":"text","text":" "},{"text":"is expired. Otherwise, the retrieved credentials will be returned via the success case as they are not expired.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Renewed credentials will be stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"url":"\/documentation\/auth0\/credentialsmanager\/user","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","type":"topic","abstract":[{"text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The user information is read from the stored "},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","type":"reference","isActive":true},{"text":".","type":"text"}],"kind":"symbol","title":"user","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"user","kind":"identifier"},{"kind":"text","text":": "},{"text":"UserInfo","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:_:)":{"kind":"symbol","title":"revoke(headers:_:)","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], (","kind":"text"},{"text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"abstract":[{"text":"Calls the ","type":"text"},{"type":"codeVoice","code":"\/oauth\/revoke"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"was successful. Otherwise, the credentials will not be cleared and the callback will be called with a failure"},{"text":" ","type":"text"},{"type":"text","text":"result containing a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","isActive":true},{"text":" error.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/init(authentication:storeKey:storage:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)","kind":"symbol","title":"init(authentication:storeKey:storage:)","abstract":[{"type":"text","text":"Creates a new "},{"code":"CredentialsManager","type":"codeVoice"},{"type":"text","text":" instance."}],"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"authentication","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication"},{"text":", ","kind":"text"},{"text":"storeKey","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"storage","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsStorage","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")","kind":"text"}],"type":"topic","role":"symbol","title":"renew(parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"inlineContent":[{"text":"This method is thread-safe","type":"text"}],"type":"strong"},{"text":".","type":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)":{"url":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","type":"topic","abstract":[{"type":"text","text":"Enables biometric authentication for additional security during credentials retrieval."}],"kind":"symbol","title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enableBiometrics","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withTitle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"cancelTitle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"fallbackTitle"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"evaluationPolicy","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@LAPolicy","text":"LAPolicy"},{"kind":"text","text":")"}]}}} \ No newline at end of file +{"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"type":"aside","style":"warning","name":"Warning","content":[{"type":"paragraph","inlineContent":[{"text":"The Credentials Manager is not thread-safe, except for its","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","isActive":true},{"text":" and","type":"text"},{"text":" ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)"},{"type":"text","text":" methods. To avoid concurrency issues, do not call its"},{"type":"text","text":" "},{"type":"text","text":"non thread-safe methods and properties from different threads without proper synchronization."}]}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"metadata":{"modules":[{"name":"Auth0"}],"title":"CredentialsManager","externalID":"s:5Auth018CredentialsManagerV","role":"symbol","symbolKind":"struct","roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)"]},{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user"]},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"topic","title":"revokeFailed","abstract":[{"type":"text","text":"The revocation of the refresh token failed."},{"type":"text","text":" "},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":" property.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-3jl3m":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}],"role":"symbol","type":"topic","title":"renew(parameters:headers:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"inlineContent":[{"text":"This method is thread-safe","type":"text"}],"type":"strong"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/init(authentication:storeKey:storage:)":{"title":"init(authentication:storeKey:storage:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)","kind":"symbol","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"authentication","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storeKey"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"text":"CredentialsStorage","kind":"typeIdentifier","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"text":")","kind":"text"}],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"CredentialsManager"},{"text":" instance.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"role":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors","kind":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-11d2f":{"role":"symbol","title":"credentials(withScope:minTTL:parameters:headers:)","abstract":[{"text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token","type":"text"},{"type":"text","text":" "},{"type":"text","text":"is expired. Otherwise, return the retrieved credentials as they are not expired. Renewed credentials will be"},{"text":" ","type":"text"},{"type":"text","text":"stored in the Keychain. "},{"inlineContent":[{"text":"This method is thread-safe","type":"text"}],"type":"strong"},{"type":"text","text":"."}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/user","abstract":[{"type":"text","text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired."},{"text":" ","type":"text"},{"type":"text","text":"The user information is read from the stored "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","isActive":true},{"text":".","type":"text"}],"kind":"symbol","title":"user"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:_:)":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","title":"revoke(headers:_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"], ("},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Calls the "},{"type":"codeVoice","code":"\/oauth\/revoke"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials will not be cleared and the callback will be called with a failure","type":"text"},{"text":" ","type":"text"},{"text":"result containing a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","isActive":true},{"type":"text","text":" error."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","kind":"symbol","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","role":"symbol","title":"store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":")"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","title":"renew(parameters:headers:callback:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)":{"url":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)","abstract":[{"text":"Enables biometric authentication for additional security during credentials retrieval.","type":"text"}],"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"enableBiometrics"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withTitle"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"cancelTitle","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"fallbackTitle","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"evaluationPolicy","kind":"externalParam"},{"kind":"text","text":": "},{"text":"LAPolicy","kind":"typeIdentifier","preciseIdentifier":"c:@E@LAPolicy"},{"text":")","kind":"text"}],"type":"topic","role":"symbol","title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"title":"clear()","role":"symbol","abstract":[{"type":"text","text":"Clears credentials stored in the Keychain."}],"url":"\/documentation\/auth0\/credentialsmanager\/clear()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:callback:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","title":"credentials(withScope:minTTL:parameters:headers:callback:)","role":"symbol","abstract":[{"text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"is expired. Otherwise, the retrieved credentials will be returned via the success case as they are not expired."},{"type":"text","text":" "},{"text":"Renewed credentials will be stored in the Keychain. ","type":"text"},{"inlineContent":[{"text":"This method is thread-safe","type":"text"}],"type":"strong"},{"type":"text","text":"."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], "},{"text":"callback","kind":"externalParam"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"canRenew"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","title":"canRenew()","abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the credentials contain a refresh token. If you are using"},{"type":"text","text":" "},{"type":"text","text":"refresh tokens, use this method instead of "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)"},{"type":"text","text":" to check for stored credentials when your app"},{"type":"text","text":" "},{"type":"text","text":"starts up."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},"https://auth0.com/docs/secure/tokens/id-tokens":{"titleInlineContent":[{"type":"text","text":"ID token"}],"title":"ID token","type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-7yn20":{"kind":"symbol","title":"renew(parameters:headers:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20","role":"symbol","type":"topic","abstract":[{"text":"Renews credentials using the refresh token and stores them in the Keychain. ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-9mzo6":{"type":"topic","role":"symbol","abstract":[{"text":"Calls the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"type":"text","text":" "},{"text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","title":"revoke(headers:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"hasValid","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"hasValid(minTTL:)","role":"symbol","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within"},{"type":"text","text":" "},{"type":"text","text":"the specified TTL. If you are not using refresh tokens, use this method instead of "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},{"type":"text","text":" to"},{"text":" ","type":"text"},{"text":"check for stored credentials when your app starts up.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-7xldm":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","title":"credentials(withScope:minTTL:parameters:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}],"type":"topic","kind":"symbol","abstract":[{"text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"is expired. Otherwise, the subscription will complete with the retrieved credentials as they are not expired."},{"text":" ","type":"text"},{"type":"text","text":"Renewed credentials will be stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-6wgai":{"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai","kind":"symbol","title":"revoke(headers:)","type":"topic","abstract":[{"type":"text","text":"Calls the "},{"type":"codeVoice","code":"\/oauth\/revoke"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and an error is thrown."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/canrenew().json b/docs/data/documentation/auth0/credentialsmanager/canrenew().json index 0f346e98..c0dec0b4 100644 --- a/docs/data/documentation/auth0/credentialsmanager/canrenew().json +++ b/docs/data/documentation/auth0/credentialsmanager/canrenew().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"canRenew","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}]},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If there are credentials stored containing a refresh token."}]}],"kind":"content"},{"content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"type":"codeListing","code":["guard credentialsManager.canRenew() else {"," \/\/ No renewable credentials exist, present the login page","}","\/\/ Retrieve the stored credentials"],"syntax":"swift"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsManagerV8canRenewSbyF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"canRenew","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"roleHeading":"Instance Method","role":"symbol","title":"canRenew()","symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"Checks that there are credentials stored, and that the credentials contain a refresh token. If you are using","type":"text"},{"type":"text","text":" "},{"type":"text","text":"refresh tokens, use this method instead of "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)"},{"text":" to check for stored credentials when your app","type":"text"},{"text":" ","type":"text"},{"text":"starts up.","type":"text"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/canrenew()"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hasValid","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","abstract":[{"text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within","type":"text"},{"type":"text","text":" "},{"type":"text","text":"the specified TTL. If you are not using refresh tokens, use this method instead of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","type":"reference","isActive":true},{"type":"text","text":" to"},{"text":" ","type":"text"},{"text":"check for stored credentials when your app starts up.","type":"text"}],"title":"hasValid(minTTL:)","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"canRenew","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","abstract":[{"text":"Checks that there are credentials stored, and that the credentials contain a refresh token. If you are using","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"refresh tokens, use this method instead of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","isActive":true,"type":"reference"},{"text":" to check for stored credentials when your app","type":"text"},{"text":" ","type":"text"},{"text":"starts up.","type":"text"}],"title":"canRenew()","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"title":"canRenew()","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"canRenew","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV8canRenewSbyF","symbolKind":"method","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"canRenew","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"If there are credentials stored containing a refresh token."}]}]},{"content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"code":["guard credentialsManager.canRenew() else {"," \/\/ No renewable credentials exist, present the login page","}","\/\/ Retrieve the stored credentials"],"syntax":"swift","type":"codeListing"}],"kind":"content"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Checks that there are credentials stored, and that the credentials contain a refresh token. If you are using","type":"text"},{"type":"text","text":" "},{"text":"refresh tokens, use this method instead of ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)"},{"text":" to check for stored credentials when your app","type":"text"},{"type":"text","text":" "},{"type":"text","text":"starts up."}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/canrenew()"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"canRenew"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","title":"canRenew()","abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the credentials contain a refresh token. If you are using"},{"type":"text","text":" "},{"type":"text","text":"refresh tokens, use this method instead of "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)"},{"type":"text","text":" to check for stored credentials when your app"},{"type":"text","text":" "},{"type":"text","text":"starts up."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"hasValid","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"hasValid(minTTL:)","role":"symbol","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within"},{"type":"text","text":" "},{"type":"text","text":"the specified TTL. If you are not using refresh tokens, use this method instead of "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},{"type":"text","text":" to"},{"text":" ","type":"text"},{"text":"check for stored credentials when your app starts up.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/clear().json b/docs/data/documentation/auth0/credentialsmanager/clear().json index d4684ea5..08073d69 100644 --- a/docs/data/documentation/auth0/credentialsmanager/clear().json +++ b/docs/data/documentation/auth0/credentialsmanager/clear().json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Clears credentials stored in the Keychain."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"metadata":{"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV5clearSbyF","title":"clear()","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"If the credentials were removed."}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["let didClear = credentialsManager.clear()"]}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/clear()"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"abstract":[{"text":"Clears credentials stored in the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/clear()","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clear"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","kind":"symbol","title":"clear()","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()"},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Clears credentials stored in the Keychain."}],"metadata":{"externalID":"s:5Auth018CredentialsManagerV5clearSbyF","role":"symbol","title":"clear()","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clear","kind":"identifier"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the credentials were removed."}]}]},{"content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["let didClear = credentialsManager.clear()"]}],"kind":"content"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/clear()"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"title":"clear()","role":"symbol","abstract":[{"type":"text","text":"Clears credentials stored in the Keychain."}],"url":"\/documentation\/auth0\/credentialsmanager\/clear()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:)-11d2f.json b/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:)-11d2f.json index fd998289..62f8c7ba 100644 --- a/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:)-11d2f.json +++ b/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:)-11d2f.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"credentials","kind":"identifier"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}],"title":"credentials(withScope:minTTL:parameters:headers:)","extendedModule":"Auth0","symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headersAA0B0CSSSg_SiSDySSypGSDyS2SGtYaKF","modules":[{"name":"Auth0"}],"role":"symbol"},"abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token"},{"type":"text","text":" "},{"text":"is expired. Otherwise, return the retrieved credentials as they are not expired. Renewed credentials will be","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"kind":"text","text":" "},{"text":"scope","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"? = nil, "},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":" = 0, "},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"] = [:], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"] = [:]) ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials"}],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"Space-separated list of scope values to request when renewing credentials. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"type":"text","text":", which will ask for the same scopes that were requested on login."}],"type":"paragraph"}],"name":"scope"},{"content":[{"inlineContent":[{"text":"Minimum time in seconds the access token must remain valid to avoid being renewed. Defaults to ","type":"text"},{"type":"codeVoice","code":"0"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"minTTL"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use when renewing credentials."}]}],"name":"parameters"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use when renewing credentials.","type":"text"}]}],"name":"headers"}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The user’s credentials."}]}]},{"content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["do {"," let credentials = try await credentialsManager.credentials()"," print(\"Obtained credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"]},{"type":"paragraph","inlineContent":[{"text":"To avoid retrieving access tokens with too little time left, you can enforce a minimum TTL:","type":"text"}]},{"syntax":"swift","code":["let credentials = try await credentialsManager.credentials(minTTL: 60)"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers for the credentials renewal:"}]},{"type":"codeListing","code":["let credentials = try await credentialsManager.credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"When renewing credentials you can get a downscoped access token by requesting fewer scopes than were requested","type":"text"},{"type":"text","text":" "},{"type":"text","text":"on login. If you specify fewer scopes, the credentials will be renewed immediately, regardless of whether they"},{"type":"text","text":" "},{"text":"are expired or not.","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["let credentials = try await credentialsManager.credentials(scope: \"openid offline_access\")"]},{"type":"aside","name":"Throws","content":[{"inlineContent":[{"text":"An error of type ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","isActive":true},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note"},{"name":"Requires","content":[{"inlineContent":[{"text":"The scope ","type":"text"},{"code":"offline_access","type":"codeVoice"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"text":"the credentials are expired and there is no refresh token, a ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},{"text":" error","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"will be thrown."}],"type":"paragraph"}],"type":"aside","style":"note"},{"style":"warning","name":"Warning","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Do not call "},{"type":"codeVoice","code":"store(credentials:)"},{"text":" afterward. The Credentials Manager automatically persists the","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"renewed credentials. Since this method is thread-safe and "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","isActive":true},{"type":"text","text":" is not, calling it anyway can"},{"text":" ","type":"text"},{"text":"cause concurrency issues.","type":"text"}]}],"type":"aside"},{"name":"Important","content":[{"inlineContent":[{"type":"text","text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple"},{"type":"text","text":" "},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}],"type":"paragraph"}],"type":"aside","style":"important"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","interfaceLanguage":"swift"},"kind":"symbol","seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"abstract":[],"kind":"article","url":"\/documentation\/auth0\/refreshtokens","title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-11d2f":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"}],"abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token"},{"text":" ","type":"text"},{"type":"text","text":"is expired. Otherwise, return the retrieved credentials as they are not expired. Renewed credentials will be"},{"type":"text","text":" "},{"type":"text","text":"stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","title":"credentials(withScope:minTTL:parameters:headers:)"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"https://auth0.com/docs/api/authentication#refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","title":"store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true,"type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f"]}],"metadata":{"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}],"title":"credentials(withScope:minTTL:parameters:headers:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headersAA0B0CSSSg_SiSDySSypGSDyS2SGtYaKF","symbolKind":"method","role":"symbol","extendedModule":"Auth0"},"kind":"symbol","abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token"},{"type":"text","text":" "},{"type":"text","text":"is expired. Otherwise, return the retrieved credentials as they are not expired. Renewed credentials will be"},{"text":" ","type":"text"},{"text":"stored in the Keychain. ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":" = 0, ","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"] = [:]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of scope values to request when renewing credentials. Defaults to "},{"code":"nil","type":"codeVoice"},{"text":", which will ask for the same scopes that were requested on login.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Minimum time in seconds the access token must remain valid to avoid being renewed. Defaults to ","type":"text"},{"type":"codeVoice","code":"0"},{"text":".","type":"text"}]}],"name":"minTTL"},{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use when renewing credentials."}]}]},{"name":"headers","content":[{"inlineContent":[{"type":"text","text":"Additional headers to use when renewing credentials."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"The user’s credentials.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","code":["do {"," let credentials = try await credentialsManager.credentials()"," print(\"Obtained credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"syntax":"swift"},{"inlineContent":[{"text":"To avoid retrieving access tokens with too little time left, you can enforce a minimum TTL:","type":"text"}],"type":"paragraph"},{"code":["let credentials = try await credentialsManager.credentials(minTTL: 60)"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers for the credentials renewal:"}]},{"type":"codeListing","code":["let credentials = try await credentialsManager.credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"],"syntax":"swift"},{"inlineContent":[{"text":"When renewing credentials you can get a downscoped access token by requesting fewer scopes than were requested","type":"text"},{"text":" ","type":"text"},{"text":"on login. If you specify fewer scopes, the credentials will be renewed immediately, regardless of whether they","type":"text"},{"text":" ","type":"text"},{"text":"are expired or not.","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["let credentials = try await credentialsManager.credentials(scope: \"openid offline_access\")"],"type":"codeListing"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"An error of type "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","isActive":true},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","name":"Throws"},{"name":"Requires","style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"code":"offline_access","type":"codeVoice"},{"text":" to have been requested on login to get a refresh token from Auth0. If","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"the credentials are expired and there is no refresh token, a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","type":"reference","isActive":true},{"text":" error","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"will be thrown."}],"type":"paragraph"}]},{"style":"warning","type":"aside","name":"Warning","content":[{"inlineContent":[{"type":"text","text":"Do not call "},{"type":"codeVoice","code":"store(credentials:)"},{"text":" afterward. The Credentials Manager automatically persists the","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"renewed credentials. Since this method is thread-safe and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)"},{"type":"text","text":" is not, calling it anyway can"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}],"type":"paragraph"}]},{"type":"aside","style":"important","name":"Important","content":[{"inlineContent":[{"type":"text","text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple"},{"text":" ","type":"text"},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}],"type":"paragraph"}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"text":" instance does not contain a refresh token.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-11d2f":{"role":"symbol","title":"credentials(withScope:minTTL:parameters:headers:)","abstract":[{"text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token","type":"text"},{"type":"text","text":" "},{"type":"text","text":"is expired. Otherwise, return the retrieved credentials as they are not expired. Renewed credentials will be"},{"text":" ","type":"text"},{"type":"text","text":"stored in the Keychain. "},{"inlineContent":[{"text":"This method is thread-safe","type":"text"}],"type":"strong"},{"type":"text","text":"."}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f"},"https://auth0.com/docs/api/authentication#refresh-token":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"title":"Refresh Tokens","type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","kind":"symbol","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","role":"symbol","title":"store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"role":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors","kind":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","abstract":[]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:)-7xldm.json b/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:)-7xldm.json index 6dd304bf..0f75ce01 100644 --- a/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:)-7xldm.json +++ b/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:)-7xldm.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":" "},{"text":"scope","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"? = nil, "},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":" = 0, "},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"] = [:], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"] = [:]) -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of scope values to request when renewing credentials. Defaults to "},{"code":"nil","type":"codeVoice"},{"text":", which will ask for the same scopes that were requested on login.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"Minimum time in seconds the access token must remain valid to avoid being renewed. Defaults to ","type":"text"},{"code":"0","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"minTTL"},{"name":"parameters","content":[{"inlineContent":[{"type":"text","text":"Additional parameters to use when renewing credentials."}],"type":"paragraph"}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use when renewing credentials."}]}]}]},{"kind":"content","content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"text":"A type-erased publisher.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"code":["credentialsManager"," .credentials()"," .sink(receiveCompletion: { completion in"," if case .failure(let error) = completion {"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: { credentials in"," print(\"Obtained credentials: \\(credentials)\")"," })"," .store(in: &cancellables)"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"text":"To avoid retrieving access tokens with too little time left, you can enforce a minimum TTL:","type":"text"}],"type":"paragraph"},{"type":"codeListing","code":["credentialsManager"," .credentials(minTTL: 60)"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"syntax":"swift"},{"inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers for the credentials renewal:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"]},{"inlineContent":[{"type":"text","text":"When renewing credentials you can get a downscoped access token by requesting fewer scopes than were requested"},{"type":"text","text":" "},{"text":"on login. If you specify fewer scopes, the credentials will be renewed immediately, regardless of whether they","type":"text"},{"type":"text","text":" "},{"text":"are expired or not.","type":"text"}],"type":"paragraph"},{"type":"codeListing","code":["credentialsManager"," .credentials(scope: \"openid offline_access\")"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"syntax":"swift"},{"name":"Requires","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"The scope ","type":"text"},{"type":"codeVoice","code":"offline_access"},{"text":" to have been requested on login to get a refresh token from Auth0. If","type":"text"},{"text":" ","type":"text"},{"text":"the credentials are expired and there is no refresh token, the subscription will complete with a","type":"text"},{"type":"text","text":" "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","type":"reference"},{"text":" error.","type":"text"}]}],"style":"note"},{"style":"warning","content":[{"inlineContent":[{"type":"text","text":"Do not call "},{"type":"codeVoice","code":"store(credentials:)"},{"type":"text","text":" afterward. The Credentials Manager automatically persists the"},{"type":"text","text":" "},{"text":"renewed credentials. Since this method is thread-safe and ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)"},{"text":" is not, calling it anyway can","type":"text"},{"type":"text","text":" "},{"text":"cause concurrency issues.","type":"text"}],"type":"paragraph"}],"name":"Warning","type":"aside"},{"type":"aside","name":"Important","content":[{"type":"paragraph","inlineContent":[{"text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple","type":"text"},{"type":"text","text":" "},{"text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances.","type":"text"}]}],"style":"important"}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","interfaceLanguage":"swift"},"metadata":{"title":"credentials(withScope:minTTL:parameters:headers:)","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Method","extendedModule":"Auth0","externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headers7Combine12AnyPublisherVyAA0B0CAA0bC5ErrorVGSSSg_SiSDySSypGSDyS2SGtF","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"kind":"symbol","abstract":[{"text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token","type":"text"},{"type":"text","text":" "},{"type":"text","text":"is expired. Otherwise, the subscription will complete with the retrieved credentials as they are not expired."},{"text":" ","type":"text"},{"type":"text","text":"Renewed credentials will be stored in the Keychain. "},{"inlineContent":[{"text":"This method is thread-safe","type":"text"}],"type":"strong"},{"text":".","type":"text"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true,"type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol"},"https://auth0.com/docs/api/authentication#refresh-token":{"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-7xldm":{"type":"topic","abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token"},{"text":" ","type":"text"},{"type":"text","text":"is expired. Otherwise, the subscription will complete with the retrieved credentials as they are not expired."},{"type":"text","text":" "},{"type":"text","text":"Renewed credentials will be stored in the Keychain. "},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"type":"text","text":"."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"kind":"symbol","title":"credentials(withScope:minTTL:parameters:headers:)","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"abstract":[],"kind":"article","url":"\/documentation\/auth0\/refreshtokens","title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","title":"store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"}}} \ No newline at end of file +{"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"title":"credentials(withScope:minTTL:parameters:headers:)","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"extendedModule":"Auth0","modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headers7Combine12AnyPublisherVyAA0B0CAA0bC5ErrorVGSSSg_SiSDySSypGSDyS2SGtF","role":"symbol"},"abstract":[{"text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token","type":"text"},{"type":"text","text":" "},{"text":"is expired. Otherwise, the subscription will complete with the retrieved credentials as they are not expired.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Renewed credentials will be stored in the Keychain. "},{"inlineContent":[{"text":"This method is thread-safe","type":"text"}],"type":"strong"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":" = 0, "},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"] = [:]) -> ","kind":"text"},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of scope values to request when renewing credentials. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"type":"text","text":", which will ask for the same scopes that were requested on login."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Minimum time in seconds the access token must remain valid to avoid being renewed. Defaults to "},{"type":"codeVoice","code":"0"},{"type":"text","text":"."}]}],"name":"minTTL"},{"content":[{"inlineContent":[{"text":"Additional parameters to use when renewing credentials.","type":"text"}],"type":"paragraph"}],"name":"parameters"},{"name":"headers","content":[{"inlineContent":[{"text":"Additional headers to use when renewing credentials.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"inlineContent":[{"type":"text","text":"A type-erased publisher."}],"type":"paragraph"}],"kind":"content"},{"content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"code":["credentialsManager"," .credentials()"," .sink(receiveCompletion: { completion in"," if case .failure(let error) = completion {"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: { credentials in"," print(\"Obtained credentials: \\(credentials)\")"," })"," .store(in: &cancellables)"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"To avoid retrieving access tokens with too little time left, you can enforce a minimum TTL:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .credentials(minTTL: 60)"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"]},{"inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers for the credentials renewal:"}],"type":"paragraph"},{"type":"codeListing","code":["credentialsManager"," .credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"syntax":"swift"},{"inlineContent":[{"type":"text","text":"When renewing credentials you can get a downscoped access token by requesting fewer scopes than were requested"},{"text":" ","type":"text"},{"type":"text","text":"on login. If you specify fewer scopes, the credentials will be renewed immediately, regardless of whether they"},{"text":" ","type":"text"},{"text":"are expired or not.","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["credentialsManager"," .credentials(scope: \"openid offline_access\")"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"type":"codeListing"},{"type":"aside","name":"Requires","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"text":" ","type":"text"},{"type":"text","text":"the credentials are expired and there is no refresh token, the subscription will complete with a"},{"type":"text","text":" "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"text":" error.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Do not call "},{"code":"store(credentials:)","type":"codeVoice"},{"type":"text","text":" afterward. The Credentials Manager automatically persists the"},{"text":" ","type":"text"},{"text":"renewed credentials. Since this method is thread-safe and ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","isActive":true},{"type":"text","text":" is not, calling it anyway can"},{"type":"text","text":" "},{"text":"cause concurrency issues.","type":"text"}]}],"type":"aside","name":"Warning","style":"warning"},{"content":[{"inlineContent":[{"type":"text","text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple"},{"text":" ","type":"text"},{"text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances.","type":"text"}],"type":"paragraph"}],"type":"aside","name":"Important","style":"important"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","kind":"symbol","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","role":"symbol","title":"store(credentials:)"},"https://auth0.com/docs/api/authentication#refresh-token":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"role":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors","kind":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","type":"link","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-7xldm":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","title":"credentials(withScope:minTTL:parameters:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}],"type":"topic","kind":"symbol","abstract":[{"text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"is expired. Otherwise, the subscription will complete with the retrieved credentials as they are not expired."},{"text":" ","type":"text"},{"type":"text","text":"Renewed credentials will be stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"text":" instance does not contain a refresh token.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:callback:).json b/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:callback:).json index 82bf51b3..bbae75a9 100644 --- a/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:callback:).json +++ b/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:callback:).json @@ -1 +1 @@ -{"sections":[],"metadata":{"externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headers8callbackySSSg_SiSDySSypGSDyS2SGys6ResultOyAA0B0CAA0bC5ErrorVGctF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"title":"credentials(withScope:minTTL:parameters:headers:callback:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"kind":"text","text":" "},{"text":"scope","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":" = 0, ","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"] = [:], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"] = [:], ","kind":"text"},{"kind":"externalParam","text":"callback"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Space-separated list of scope values to request when renewing credentials. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":", which will ask for the same scopes that were requested on login.","type":"text"}],"type":"paragraph"}],"name":"scope"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Minimum time in seconds the access token must remain valid to avoid being renewed. Defaults to ","type":"text"},{"code":"0","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"minTTL"},{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use when renewing credentials."}]}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use when renewing credentials.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Callback that receives a ","type":"text"},{"type":"codeVoice","code":"Result"},{"text":" containing either the user’s credentials or an error.","type":"text"}]}],"name":"callback"}]},{"kind":"content","content":[{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"code":["credentialsManager.credentials { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"syntax":"swift","type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"To avoid retrieving access tokens with too little time left, you can enforce a minimum TTL:"}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager.credentials(minTTL: 60) { print($0) }"]},{"inlineContent":[{"text":"If you need to specify custom parameters or headers for the credentials renewal:","type":"text"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["credentialsManager.credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"When renewing credentials you can get a downscoped access token by requesting fewer scopes than were requested"},{"type":"text","text":" "},{"type":"text","text":"on login. If you specify fewer scopes, the credentials will be renewed immediately, regardless of whether they"},{"text":" ","type":"text"},{"text":"are expired or not.","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager.credentials(scope: \"openid offline_access\") { print($0) }"]},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"the credentials are expired and there is no refresh token, the callback will be called with a"},{"text":" ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","type":"reference"},{"text":" error.","type":"text"}],"type":"paragraph"}],"name":"Requires","style":"note"},{"type":"aside","name":"Warning","style":"warning","content":[{"inlineContent":[{"text":"Do not call ","type":"text"},{"type":"codeVoice","code":"store(credentials:)"},{"text":" afterward. The Credentials Manager automatically persists the","type":"text"},{"type":"text","text":" "},{"text":"renewed credentials. Since this method is thread-safe and ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","isActive":true,"type":"reference"},{"type":"text","text":" is not, calling it anyway can"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}],"type":"paragraph"}]},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}]}],"name":"Important","style":"important"}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token"},{"type":"text","text":" "},{"type":"text","text":"is expired. Otherwise, the retrieved credentials will be returned via the success case as they are not expired."},{"type":"text","text":" "},{"text":"Renewed credentials will be stored in the Keychain. ","type":"text"},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"type":"text","text":"."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"https://auth0.com/docs/api/authentication#refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"abstract":[],"kind":"article","url":"\/documentation\/auth0\/refreshtokens","title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:callback:)":{"title":"credentials(withScope:minTTL:parameters:headers:callback:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","kind":"symbol","abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token"},{"type":"text","text":" "},{"text":"is expired. Otherwise, the retrieved credentials will be returned via the success case as they are not expired.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Renewed credentials will be stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true,"type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","title":"store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"role":"symbol","title":"credentials(withScope:minTTL:parameters:headers:callback:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headers8callbackySSSg_SiSDySSypGSDyS2SGys6ResultOyAA0B0CAA0bC5ErrorVGctF"},"sections":[],"abstract":[{"text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token","type":"text"},{"type":"text","text":" "},{"text":"is expired. Otherwise, the retrieved credentials will be returned via the success case as they are not expired.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Renewed credentials will be stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"text":".","type":"text"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"text":" ","kind":"text"},{"text":"scope","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"text":" = 0, ","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"] = [:], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": "},{"kind":"attribute","text":"@escaping"},{"text":" (","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of scope values to request when renewing credentials. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":", which will ask for the same scopes that were requested on login.","type":"text"}],"type":"paragraph"}],"name":"scope"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Minimum time in seconds the access token must remain valid to avoid being renewed. Defaults to "},{"type":"codeVoice","code":"0"},{"type":"text","text":"."}]}],"name":"minTTL"},{"content":[{"inlineContent":[{"type":"text","text":"Additional parameters to use when renewing credentials."}],"type":"paragraph"}],"name":"parameters"},{"content":[{"inlineContent":[{"text":"Additional headers to use when renewing credentials.","type":"text"}],"type":"paragraph"}],"name":"headers"},{"name":"callback","content":[{"inlineContent":[{"type":"text","text":"Callback that receives a "},{"type":"codeVoice","code":"Result"},{"type":"text","text":" containing either the user’s credentials or an error."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"code":["credentialsManager.credentials { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"To avoid retrieving access tokens with too little time left, you can enforce a minimum TTL:"}]},{"syntax":"swift","type":"codeListing","code":["credentialsManager.credentials(minTTL: 60) { print($0) }"]},{"inlineContent":[{"text":"If you need to specify custom parameters or headers for the credentials renewal:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["credentialsManager.credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"When renewing credentials you can get a downscoped access token by requesting fewer scopes than were requested"},{"type":"text","text":" "},{"type":"text","text":"on login. If you specify fewer scopes, the credentials will be renewed immediately, regardless of whether they"},{"type":"text","text":" "},{"type":"text","text":"are expired or not."}],"type":"paragraph"},{"code":["credentialsManager.credentials(scope: \"openid offline_access\") { print($0) }"],"type":"codeListing","syntax":"swift"},{"name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"text":" ","type":"text"},{"text":"the credentials are expired and there is no refresh token, the callback will be called with a","type":"text"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},{"type":"text","text":" error."}],"type":"paragraph"}],"style":"note","type":"aside"},{"content":[{"inlineContent":[{"type":"text","text":"Do not call "},{"code":"store(credentials:)","type":"codeVoice"},{"type":"text","text":" afterward. The Credentials Manager automatically persists the"},{"type":"text","text":" "},{"type":"text","text":"renewed credentials. Since this method is thread-safe and "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","isActive":true,"type":"reference"},{"type":"text","text":" is not, calling it anyway can"},{"text":" ","type":"text"},{"type":"text","text":"cause concurrency issues."}],"type":"paragraph"}],"type":"aside","style":"warning","name":"Warning"},{"style":"important","name":"Important","type":"aside","content":[{"inlineContent":[{"type":"text","text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple"},{"type":"text","text":" "},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}],"type":"paragraph"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"type":"topic","kind":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","kind":"symbol","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","role":"symbol","title":"store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"role":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors","kind":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","abstract":[]},"https://auth0.com/docs/api/authentication#refresh-token":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"text":" instance does not contain a refresh token.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:callback:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","title":"credentials(withScope:minTTL:parameters:headers:callback:)","role":"symbol","abstract":[{"text":"Retrieves credentials from the Keychain and yields new credentials using the refresh token if the access token","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"is expired. Otherwise, the retrieved credentials will be returned via the success case as they are not expired."},{"type":"text","text":" "},{"text":"Renewed credentials will be stored in the Keychain. ","type":"text"},{"inlineContent":[{"text":"This method is thread-safe","type":"text"}],"type":"strong"},{"type":"text","text":"."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], "},{"text":"callback","kind":"externalParam"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:).json b/docs/data/documentation/auth0/credentialsmanager/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:).json index 82c1188d..20bd630e 100644 --- a/docs/data/documentation/auth0/credentialsmanager/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:).json +++ b/docs/data/documentation/auth0/credentialsmanager/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:).json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"abstract":[{"type":"text","text":"Enables biometric authentication for additional security during credentials retrieval."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"mutating","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"enableBiometrics"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withTitle"},{"text":" ","kind":"text"},{"text":"title","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"cancelTitle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"fallbackTitle"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"? = nil, "},{"text":"evaluationPolicy","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"LAPolicy","preciseIdentifier":"c:@E@LAPolicy","kind":"typeIdentifier"},{"text":" = .deviceOwnerAuthenticationWithBiometrics)","kind":"text"}]}]},{"parameters":[{"name":"title","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Main message to display when Face ID or Touch ID is used."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Cancel message to display when Face ID or Touch ID is used.","type":"text"}]}],"name":"cancelTitle"},{"name":"fallbackTitle","content":[{"type":"paragraph","inlineContent":[{"text":"Fallback message to display when Face ID or Touch ID is used after a failed match.","type":"text"}]}]},{"content":[{"inlineContent":[{"text":"Policy to be used for authentication policy evaluation.","type":"text"}],"type":"paragraph"}],"name":"evaluationPolicy"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["credentialsManager.enableBiometrics(withTitle: \"Unlock with Face ID\")"]},{"inlineContent":[{"text":"If needed, you can specify a particular ","type":"text"},{"code":"LAPolicy","type":"codeVoice"},{"type":"text","text":" to be used. For example, you might want to support Face ID or"},{"type":"text","text":" "},{"type":"text","text":"Touch ID, but also allow fallback to passcode."}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["credentialsManager.enableBiometrics(withTitle: \"Unlock with Face ID or passcode\", "," evaluationPolicy: .deviceOwnerAuthentication)"]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Access to the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","isActive":true,"type":"reference"},{"text":" property will not be protected by biometric authentication.","type":"text"}]}],"style":"important","name":"Important","type":"aside"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)"]}],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV16enableBiometrics9withTitle06cancelG008fallbackG016evaluationPolicyySS_SSSgAISo8LAPolicyVtF","title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"enableBiometrics"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withTitle"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"cancelTitle"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"fallbackTitle"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"evaluationPolicy","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"LAPolicy","kind":"typeIdentifier","preciseIdentifier":"c:@E@LAPolicy"},{"kind":"text","text":")"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"url":"\/documentation\/auth0\/credentialsmanager\/user","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","type":"topic","abstract":[{"text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The user information is read from the stored "},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","type":"reference","isActive":true},{"text":".","type":"text"}],"kind":"symbol","title":"user","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"user","kind":"identifier"},{"kind":"text","text":": "},{"text":"UserInfo","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)":{"url":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","type":"topic","abstract":[{"type":"text","text":"Enables biometric authentication for additional security during credentials retrieval."}],"kind":"symbol","title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enableBiometrics","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withTitle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"cancelTitle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"fallbackTitle"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"evaluationPolicy","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@LAPolicy","text":"LAPolicy"},{"kind":"text","text":")"}]},"https://auth0.com/docs/secure/tokens/id-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","title":"ID token","titleInlineContent":[{"type":"text","text":"ID token"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"mutating"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"enableBiometrics","kind":"identifier"},{"kind":"text","text":"("},{"text":"withTitle","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"title"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"cancelTitle","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"text":"fallbackTitle","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"evaluationPolicy"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@LAPolicy","text":"LAPolicy","kind":"typeIdentifier"},{"text":" = .deviceOwnerAuthenticationWithBiometrics)","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Main message to display when Face ID or Touch ID is used."}],"type":"paragraph"}],"name":"title"},{"name":"cancelTitle","content":[{"inlineContent":[{"type":"text","text":"Cancel message to display when Face ID or Touch ID is used."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Fallback message to display when Face ID or Touch ID is used after a failed match."}]}],"name":"fallbackTitle"},{"name":"evaluationPolicy","content":[{"type":"paragraph","inlineContent":[{"text":"Policy to be used for authentication policy evaluation.","type":"text"}]}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["credentialsManager.enableBiometrics(withTitle: \"Unlock with Face ID\")"]},{"inlineContent":[{"text":"If needed, you can specify a particular ","type":"text"},{"code":"LAPolicy","type":"codeVoice"},{"text":" to be used. For example, you might want to support Face ID or","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Touch ID, but also allow fallback to passcode."}],"type":"paragraph"},{"code":["credentialsManager.enableBiometrics(withTitle: \"Unlock with Face ID or passcode\", "," evaluationPolicy: .deviceOwnerAuthentication)"],"type":"codeListing","syntax":"swift"},{"name":"Important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Access to the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","isActive":true},{"type":"text","text":" property will not be protected by biometric authentication."}]}],"type":"aside","style":"important"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)"]}],"metadata":{"externalID":"s:5Auth018CredentialsManagerV16enableBiometrics9withTitle06cancelG008fallbackG016evaluationPolicyySS_SSSgAISo8LAPolicyVtF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"enableBiometrics","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withTitle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"cancelTitle","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"fallbackTitle"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"evaluationPolicy","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"LAPolicy","preciseIdentifier":"c:@E@LAPolicy","kind":"typeIdentifier"},{"text":")","kind":"text"}],"modules":[{"name":"Auth0"}],"title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"abstract":[{"text":"Enables biometric authentication for additional security during credentials retrieval.","type":"text"}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"https://auth0.com/docs/secure/tokens/id-tokens":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","titleInlineContent":[{"text":"ID token","type":"text"}],"title":"ID token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)":{"url":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)","abstract":[{"text":"Enables biometric authentication for additional security during credentials retrieval.","type":"text"}],"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"enableBiometrics"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withTitle"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"cancelTitle","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"text":"fallbackTitle","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"evaluationPolicy","kind":"externalParam"},{"kind":"text","text":": "},{"text":"LAPolicy","kind":"typeIdentifier","preciseIdentifier":"c:@E@LAPolicy"},{"text":")","kind":"text"}],"type":"topic","role":"symbol","title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/user","abstract":[{"type":"text","text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired."},{"text":" ","type":"text"},{"type":"text","text":"The user information is read from the stored "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","isActive":true},{"text":".","type":"text"}],"kind":"symbol","title":"user"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/hasvalid(minttl:).json b/docs/data/documentation/auth0/credentialsmanager/hasvalid(minttl:).json index 3568ff9c..321c8340 100644 --- a/docs/data/documentation/auth0/credentialsmanager/hasvalid(minttl:).json +++ b/docs/data/documentation/auth0/credentialsmanager/hasvalid(minttl:).json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth018CredentialsManagerV8hasValid6minTTLSbSi_tF","symbolKind":"method","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"hasValid"},{"text":"(","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"hasValid(minTTL:)"},"abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within"},{"text":" ","type":"text"},{"text":"the specified TTL. If you are not using refresh tokens, use this method instead of ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","isActive":true},{"type":"text","text":" to"},{"type":"text","text":" "},{"type":"text","text":"check for stored credentials when your app starts up."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hasValid","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":" = 0) -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"minTTL","content":[{"inlineContent":[{"text":"Minimum lifetime in seconds the access token must have left. Defaults to ","type":"text"},{"type":"codeVoice","code":"0"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"If there are credentials stored containing an access token that is neither expired or about to expire.","type":"text"}]}],"kind":"content"},{"content":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"type":"codeListing","code":["guard credentialsManager.hasValid() else {"," \/\/ No valid credentials exist, present the login page","}","\/\/ Retrieve the stored credentials"],"syntax":"swift"}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn"],"title":"Related Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"canRenew","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","abstract":[{"text":"Checks that there are credentials stored, and that the credentials contain a refresh token. If you are using","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"refresh tokens, use this method instead of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","isActive":true,"type":"reference"},{"text":" to check for stored credentials when your app","type":"text"},{"text":" ","type":"text"},{"text":"starts up.","type":"text"}],"title":"canRenew()","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"expiresIn","kind":"identifier"},{"kind":"text","text":": "},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","kind":"symbol","url":"\/documentation\/auth0\/credentials\/expiresin","type":"topic","title":"expiresIn","abstract":[{"type":"text","text":"When the access token expires."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hasValid","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","abstract":[{"text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within","type":"text"},{"type":"text","text":" "},{"type":"text","text":"the specified TTL. If you are not using refresh tokens, use this method instead of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","type":"reference","isActive":true},{"type":"text","text":" to"},{"text":" ","type":"text"},{"text":"check for stored credentials when your app starts up.","type":"text"}],"title":"hasValid(minTTL:)","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","kind":"symbol"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hasValid"},{"text":"(","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":" = 0) -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"minTTL","content":[{"inlineContent":[{"type":"text","text":"Minimum lifetime in seconds the access token must have left. Defaults to "},{"code":"0","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}]},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"inlineContent":[{"type":"text","text":"If there are credentials stored containing an access token that is neither expired or about to expire."}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"syntax":"swift","code":["guard credentialsManager.hasValid() else {"," \/\/ No valid credentials exist, present the login page","}","\/\/ Retrieve the stored credentials"],"type":"codeListing"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)"]}],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn"],"title":"Related Documentation"}],"abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within"},{"text":" ","type":"text"},{"type":"text","text":"the specified TTL. If you are not using refresh tokens, use this method instead of "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},{"text":" to","type":"text"},{"type":"text","text":" "},{"type":"text","text":"check for stored credentials when your app starts up."}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"hasValid","kind":"identifier"},{"text":"(","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","externalID":"s:5Auth018CredentialsManagerV8hasValid6minTTLSbSi_tF","symbolKind":"method","roleHeading":"Instance Method","title":"hasValid(minTTL:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"canRenew"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","title":"canRenew()","abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the credentials contain a refresh token. If you are using"},{"type":"text","text":" "},{"type":"text","text":"refresh tokens, use this method instead of "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)"},{"type":"text","text":" to check for stored credentials when your app"},{"type":"text","text":" "},{"type":"text","text":"starts up."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"hasValid","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"hasValid(minTTL:)","role":"symbol","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within"},{"type":"text","text":" "},{"type":"text","text":"the specified TTL. If you are not using refresh tokens, use this method instead of "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},{"type":"text","text":" to"},{"text":" ","type":"text"},{"text":"check for stored credentials when your app starts up.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"abstract":[{"text":"When the access token expires.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/expiresin","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","kind":"symbol","title":"expiresIn"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/init(authentication:storekey:storage:).json b/docs/data/documentation/auth0/credentialsmanager/init(authentication:storekey:storage:).json index bf135a62..c67dbdf9 100644 --- a/docs/data/documentation/auth0/credentialsmanager/init(authentication:storekey:storage:).json +++ b/docs/data/documentation/auth0/credentialsmanager/init(authentication:storekey:storage:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Creates a new "},{"code":"CredentialsManager","type":"codeVoice"},{"type":"text","text":" instance."}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"text":"authentication","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"},{"text":", ","kind":"text"},{"text":"storeKey","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" = \"credentials\", "},{"text":"storage","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsStorage","preciseIdentifier":"s:5Auth018CredentialsStorageP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},{"kind":"text","text":" = SimpleKeychain())"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"authentication","content":[{"inlineContent":[{"type":"text","text":"Auth0 Authentication API client."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"Key used to store user credentials in the Keychain. Defaults to ‘credentials’.","type":"text"}],"type":"paragraph"}],"name":"storeKey"},{"name":"storage","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},{"type":"text","text":" instance used to manage credentials storage. Defaults to a standard "},{"type":"codeVoice","code":"SimpleKeychain"},{"type":"text","text":" instance."}]}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"authentication","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP"},{"kind":"text","text":", "},{"text":"storeKey","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth018CredentialsStorageP","text":"CredentialsStorage","kind":"typeIdentifier"},{"kind":"text","text":")"}],"modules":[{"name":"Auth0"}],"roleHeading":"Initializer","title":"init(authentication:storeKey:storage:)","role":"symbol","externalID":"s:5Auth018CredentialsManagerV14authentication8storeKey7storageAcA14Authentication_p_SSAA0B7Storage_ptcfc"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"url":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/init(authentication:storeKey:storage:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)","kind":"symbol","title":"init(authentication:storeKey:storage:)","abstract":[{"type":"text","text":"Creates a new "},{"code":"CredentialsManager","type":"codeVoice"},{"type":"text","text":" instance."}],"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"authentication","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication"},{"text":", ","kind":"text"},{"text":"storeKey","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"storage","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsStorage","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"}}} \ No newline at end of file +{"metadata":{"fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"authentication","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storeKey"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth018CredentialsStorageP","kind":"typeIdentifier","text":"CredentialsStorage"},{"kind":"text","text":")"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"init","title":"init(authentication:storeKey:storage:)","externalID":"s:5Auth018CredentialsManagerV14authentication8storeKey7storageAcA14Authentication_p_SSAA0B7Storage_ptcfc","roleHeading":"Initializer"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"abstract":[{"type":"text","text":"Creates a new "},{"code":"CredentialsManager","type":"codeVoice"},{"type":"text","text":" instance."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"text":"authentication","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier","text":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"},{"text":", ","kind":"text"},{"text":"storeKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" = \"credentials\", "},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"text":"CredentialsStorage","preciseIdentifier":"s:5Auth018CredentialsStorageP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"typeIdentifier"},{"kind":"text","text":" = SimpleKeychain())"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Auth0 Authentication API client.","type":"text"}]}],"name":"authentication"},{"name":"storeKey","content":[{"type":"paragraph","inlineContent":[{"text":"Key used to store user credentials in the Keychain. Defaults to ‘credentials’.","type":"text"}]}]},{"name":"storage","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"text":" instance used to manage credentials storage. Defaults to a standard ","type":"text"},{"code":"SimpleKeychain","type":"codeVoice"},{"type":"text","text":" instance."}],"type":"paragraph"}]}]}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/init(authentication:storeKey:storage:)":{"title":"init(authentication:storeKey:storage:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)","kind":"symbol","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"authentication","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storeKey"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"text":"CredentialsStorage","kind":"typeIdentifier","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"text":")","kind":"text"}],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"CredentialsManager"},{"text":" instance.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","title":"CredentialsStorage"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:)-3jl3m.json b/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:)-3jl3m.json index e99f079e..08e8ab5f 100644 --- a/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:)-3jl3m.json +++ b/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:)-3jl3m.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"] = [:], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"] = [:]) ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use."}]}],"name":"parameters"},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use."}]}]},{"name":"callback","content":[{"inlineContent":[{"text":"Callback that receives a ","type":"text"},{"code":"Result","type":"codeVoice"},{"type":"text","text":" containing either the renewed user’s credentials or an error."}],"type":"paragraph"}]}]},{"content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"syntax":"swift","code":["do {"," let credentials = try await credentialsManager.renew()"," print(\"Renewed credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers:"}]},{"syntax":"swift","type":"codeListing","code":["let credentials = try await credentialsManager.renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"]},{"name":"Requires","style":"note","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"code":"offline_access","type":"codeVoice"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"there is no refresh token, a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},{"type":"text","text":" error will be thrown."}],"type":"paragraph"}],"type":"aside"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Do not call "},{"code":"store(credentials:)","type":"codeVoice"},{"type":"text","text":" afterward. The Credentials Manager automatically persists the"},{"type":"text","text":" "},{"type":"text","text":"renewed credentials. Since this method is thread-safe and "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)"},{"text":" is not, calling it anyway can","type":"text"},{"text":" ","type":"text"},{"text":"cause concurrency issues.","type":"text"}]}],"name":"Warning","style":"warning","type":"aside"},{"type":"aside","style":"important","name":"Important","content":[{"type":"paragraph","inlineContent":[{"text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}]}]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Renews credentials using the refresh token and stores them in the Keychain. ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m"},"metadata":{"symbolKind":"method","title":"renew(parameters:headers:)","modules":[{"name":"Auth0"}],"role":"symbol","extendedModule":"Auth0","externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headersAA0B0CSDySSypG_SDyS2SGtYaKF","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"kind":"text","text":"("},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}]},"kind":"symbol","sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","title":"store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"abstract":[],"kind":"article","url":"\/documentation\/auth0\/refreshtokens","title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true,"type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-3jl3m":{"abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}],"kind":"symbol","title":"renew(parameters:headers:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"https://auth0.com/docs/api/authentication#refresh-token":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link"}}} \ No newline at end of file +{"abstract":[{"text":"Renews credentials using the refresh token and stores them in the Keychain. ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"] = [:], "},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"] = [:]) ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}]}]},{"kind":"parameters","parameters":[{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use."}]}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Callback that receives a "},{"code":"Result","type":"codeVoice"},{"type":"text","text":" containing either the renewed user’s credentials or an error."}]}],"name":"callback"}]},{"kind":"content","content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"code":["do {"," let credentials = try await credentialsManager.renew()"," print(\"Renewed credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers:"}]},{"code":["let credentials = try await credentialsManager.renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"],"syntax":"swift","type":"codeListing"},{"style":"note","name":"Requires","type":"aside","content":[{"inlineContent":[{"text":"The scope ","type":"text"},{"code":"offline_access","type":"codeVoice"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"text":"there is no refresh token, a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true,"type":"reference"},{"text":" error will be thrown.","type":"text"}],"type":"paragraph"}]},{"style":"warning","content":[{"inlineContent":[{"type":"text","text":"Do not call "},{"type":"codeVoice","code":"store(credentials:)"},{"type":"text","text":" afterward. The Credentials Manager automatically persists the"},{"text":" ","type":"text"},{"type":"text","text":"renewed credentials. Since this method is thread-safe and "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","isActive":true},{"type":"text","text":" is not, calling it anyway can"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}],"type":"paragraph"}],"type":"aside","name":"Warning"},{"style":"important","type":"aside","name":"Important","content":[{"inlineContent":[{"type":"text","text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple"},{"type":"text","text":" "},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}],"type":"paragraph"}]}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","interfaceLanguage":"swift"},"metadata":{"title":"renew(parameters:headers:)","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","symbolKind":"method","role":"symbol","externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headersAA0B0CSDySSypG_SDyS2SGtYaKF","extendedModule":"Auth0","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m"]}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"text":" instance does not contain a refresh token.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","kind":"symbol","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","role":"symbol","title":"store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"role":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors","kind":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","abstract":[]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"https://auth0.com/docs/api/authentication#refresh-token":{"type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-3jl3m":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}],"role":"symbol","type":"topic","title":"renew(parameters:headers:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"inlineContent":[{"text":"This method is thread-safe","type":"text"}],"type":"strong"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:)-7yn20.json b/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:)-7yn20.json index 80372796..49f8ae5c 100644 --- a/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:)-7yn20.json +++ b/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:)-7yn20.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"metadata":{"extendedModule":"Auth0","symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headers7Combine12AnyPublisherVyAA0B0CAA0bC5ErrorVGSDySSypG_SDyS2SGtF","roleHeading":"Instance Method","role":"symbol","title":"renew(parameters:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"kind":"text","text":"("},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}]},"kind":"symbol","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"] = [:], "},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"] = [:]) -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"kind":"text","text":">"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional parameters to use.","type":"text"}]}],"name":"parameters"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use.","type":"text"}]}],"name":"headers"}]},{"content":[{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .renew()"," .sink(receiveCompletion: { completion in"," if case .failure(let error) = completion {"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: { credentials in"," print(\"Renewed credentials: \\(credentials)\")"," })"," .store(in: &cancellables)"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers:"}]},{"syntax":"swift","type":"codeListing","code":["credentialsManager"," .renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"]},{"type":"aside","style":"note","content":[{"inlineContent":[{"text":"The scope ","type":"text"},{"code":"offline_access","type":"codeVoice"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"there is no refresh token, the subscription will complete with a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","type":"reference","isActive":true},{"type":"text","text":" "},{"type":"text","text":"error."}],"type":"paragraph"}],"name":"Requires"},{"type":"aside","style":"warning","content":[{"type":"paragraph","inlineContent":[{"text":"Do not call ","type":"text"},{"type":"codeVoice","code":"store(credentials:)"},{"type":"text","text":" afterward. The Credentials Manager automatically persists the"},{"type":"text","text":" "},{"type":"text","text":"renewed credentials. Since this method is thread-safe and "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","type":"reference","isActive":true},{"type":"text","text":" is not, calling it anyway can"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}]}],"name":"Warning"},{"name":"Important","type":"aside","style":"important","content":[{"inlineContent":[{"text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}],"type":"paragraph"}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true,"type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-7yn20":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"text":".","type":"text"}],"type":"topic","kind":"symbol","title":"renew(parameters:headers:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"type":"link","title":"Refresh Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"abstract":[],"kind":"article","url":"\/documentation\/auth0\/refreshtokens","title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","title":"store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"https://auth0.com/docs/api/authentication#refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20"},"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20"]}],"abstract":[{"text":"Renews credentials using the refresh token and stores them in the Keychain. ","type":"text"},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"renew","kind":"identifier"},{"kind":"text","text":"("},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"] = [:], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"] = [:]) -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"parameters","content":[{"inlineContent":[{"type":"text","text":"Additional parameters to use."}],"type":"paragraph"}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use.","type":"text"}]}]}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"code":["credentialsManager"," .renew()"," .sink(receiveCompletion: { completion in"," if case .failure(let error) = completion {"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: { credentials in"," print(\"Renewed credentials: \\(credentials)\")"," })"," .store(in: &cancellables)"],"syntax":"swift","type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers:"}]},{"syntax":"swift","code":["credentialsManager"," .renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"type":"codeListing"},{"name":"Requires","content":[{"inlineContent":[{"text":"The scope ","type":"text"},{"code":"offline_access","type":"codeVoice"},{"text":" to have been requested on login to get a refresh token from Auth0. If","type":"text"},{"type":"text","text":" "},{"type":"text","text":"there is no refresh token, the subscription will complete with a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"type":"text","text":" "},{"type":"text","text":"error."}],"type":"paragraph"}],"style":"note","type":"aside"},{"style":"warning","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Do not call "},{"type":"codeVoice","code":"store(credentials:)"},{"type":"text","text":" afterward. The Credentials Manager automatically persists the"},{"type":"text","text":" "},{"type":"text","text":"renewed credentials. Since this method is thread-safe and "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","isActive":true},{"text":" is not, calling it anyway can","type":"text"},{"text":" ","type":"text"},{"text":"cause concurrency issues.","type":"text"}]}],"name":"Warning","type":"aside"},{"type":"aside","style":"important","content":[{"type":"paragraph","inlineContent":[{"text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple","type":"text"},{"type":"text","text":" "},{"text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances.","type":"text"}]}],"name":"Important"}],"kind":"content"}],"metadata":{"externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headers7Combine12AnyPublisherVyAA0B0CAA0bC5ErrorVGSDySSypG_SDyS2SGtF","title":"renew(parameters:headers:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":">"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","kind":"symbol","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","role":"symbol","title":"store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"text":" instance does not contain a refresh token.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"role":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors","kind":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","abstract":[]},"https://auth0.com/docs/api/authentication#refresh-token":{"title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","title":"Refresh Tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-7yn20":{"kind":"symbol","title":"renew(parameters:headers:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20","role":"symbol","type":"topic","abstract":[{"text":"Renews credentials using the refresh token and stores them in the Keychain. ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:callback:).json b/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:callback:).json index b01f63c1..a11d78eb 100644 --- a/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:callback:).json +++ b/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:callback:).json @@ -1 +1 @@ -{"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"text":"callback","kind":"externalParam"},{"kind":"text","text":": ("},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headers8callbackySDySSypG_SDyS2SGys6ResultOyAA0B0CAA0bC5ErrorVGctF","modules":[{"name":"Auth0"}],"title":"renew(parameters:headers:callback:)"},"abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"text":".","type":"text"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"] = [:], ","kind":"text"},{"kind":"externalParam","text":"callback"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"kind":"text","text":" ("},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult"},{"kind":"text","text":"<"},{"text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use."}]}],"name":"parameters"},{"name":"headers","content":[{"inlineContent":[{"type":"text","text":"Additional headers to use."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Callback that receives a "},{"code":"Result","type":"codeVoice"},{"text":" containing either the renewed user’s credentials or an error.","type":"text"}]}],"name":"callback"}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"type":"heading","text":"Usage","anchor":"Usage"},{"syntax":"swift","code":["credentialsManager.renew { result in"," switch result {"," case .success(let credentials):"," print(\"Renewed credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers:"}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager.renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"]},{"name":"Requires","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"text":" to have been requested on login to get a refresh token from Auth0. If","type":"text"},{"text":" ","type":"text"},{"text":"there is no refresh token, the callback will be called with a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true,"type":"reference"},{"type":"text","text":" error."}]}]},{"type":"aside","name":"Warning","content":[{"type":"paragraph","inlineContent":[{"text":"Do not call ","type":"text"},{"code":"store(credentials:)","type":"codeVoice"},{"type":"text","text":" afterward. The Credentials Manager automatically persists the"},{"type":"text","text":" "},{"text":"renewed credentials. Since this method is thread-safe and ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","isActive":true},{"text":" is not, calling it anyway can","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"cause concurrency issues."}]}],"style":"warning"},{"content":[{"type":"paragraph","inlineContent":[{"text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}]}],"name":"Important","type":"aside","style":"important"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true,"type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"abstract":[],"kind":"article","url":"\/documentation\/auth0\/refreshtokens","title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")","kind":"text"}],"type":"topic","role":"symbol","title":"renew(parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"inlineContent":[{"text":"This method is thread-safe","type":"text"}],"type":"strong"},{"text":".","type":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","title":"Refresh Tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"https://auth0.com/docs/api/authentication#refresh-token":{"type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","title":"store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"}}} \ No newline at end of file +{"kind":"symbol","seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation"}],"metadata":{"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headers8callbackySDySSypG_SDyS2SGys6ResultOyAA0B0CAA0bC5ErrorVGctF","title":"renew(parameters:headers:callback:)","modules":[{"name":"Auth0"}]},"abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"] = [:], "},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"] = [:], ","kind":"text"},{"kind":"externalParam","text":"callback"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"kind":"text","text":" ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")"}]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Additional parameters to use."}],"type":"paragraph"}],"name":"parameters"},{"content":[{"inlineContent":[{"type":"text","text":"Additional headers to use."}],"type":"paragraph"}],"name":"headers"},{"name":"callback","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Callback that receives a "},{"type":"codeVoice","code":"Result"},{"type":"text","text":" containing either the renewed user’s credentials or an error."}]}]}]},{"kind":"content","content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"type":"codeListing","code":["credentialsManager.renew { result in"," switch result {"," case .success(let credentials):"," print(\"Renewed credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"syntax":"swift"},{"inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers:"}],"type":"paragraph"},{"syntax":"swift","code":["credentialsManager.renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"],"type":"codeListing"},{"type":"aside","name":"Requires","style":"note","content":[{"inlineContent":[{"text":"The scope ","type":"text"},{"code":"offline_access","type":"codeVoice"},{"text":" to have been requested on login to get a refresh token from Auth0. If","type":"text"},{"type":"text","text":" "},{"text":"there is no refresh token, the callback will be called with a ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},{"type":"text","text":" error."}],"type":"paragraph"}]},{"style":"warning","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"Do not call ","type":"text"},{"type":"codeVoice","code":"store(credentials:)"},{"type":"text","text":" afterward. The Credentials Manager automatically persists the"},{"type":"text","text":" "},{"text":"renewed credentials. Since this method is thread-safe and ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)"},{"type":"text","text":" is not, calling it anyway can"},{"text":" ","type":"text"},{"text":"cause concurrency issues.","type":"text"}]}],"name":"Warning"},{"style":"important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple"},{"text":" ","type":"text"},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}]}],"type":"aside","name":"Important"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","kind":"symbol","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","role":"symbol","title":"store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"role":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","title":"Refresh Tokens: Common Errors","kind":"article","type":"topic","url":"\/documentation\/auth0\/refreshtokens","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","title":"Refresh Tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"text":" instance does not contain a refresh token.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"https://auth0.com/docs/api/authentication#refresh-token":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"type":"topic","kind":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":")"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","title":"renew(parameters:headers:callback:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-6wgai.json b/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-6wgai.json index 7aa3d5a9..bb999464 100644 --- a/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-6wgai.json +++ b/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-6wgai.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"metadata":{"externalID":"s:5Auth018CredentialsManagerV6revoke7headersySDyS2SG_tYaKF","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"]) "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"title":"revoke(headers:)","modules":[{"name":"Auth0"}],"extendedModule":"Auth0"},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai"},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"]}],"abstract":[{"type":"text","text":"Calls the "},{"type":"codeVoice","code":"\/oauth\/revoke"},{"type":"text","text":" endpoint to revoke the refresh token and then clears the credentials if the request"},{"type":"text","text":" "},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and an error is thrown."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"] = [:]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Additional headers to use when revoking the refresh token."}],"type":"paragraph"}],"name":"headers"}],"kind":"parameters"},{"content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["do {"," try await credentialsManager.revoke()"," print(\"Revoked refresh token and cleared credentials\")","} catch {"," print(\"Failed with: \\(error)\")","}"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom headers for the refresh token revocation:"}]},{"syntax":"swift","code":["try await credentialsManager.revoke(headers: [\"key\": \"value\"])"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"If no refresh token is available the endpoint is not called, the credentials are cleared, and no error is thrown."}],"type":"paragraph"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error of type "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","isActive":true},{"type":"text","text":"."}]}],"name":"Throws","type":"aside","style":"note"}],"kind":"content"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-6wgai":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]) "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai","type":"topic","title":"revoke(headers:)","kind":"symbol","abstract":[{"type":"text","text":"Calls the "},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint to revoke the refresh token and then clears the credentials if the request"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials are not cleared and an error is thrown.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"title":"Refresh Tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"]}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"roleHeading":"Instance Method","role":"symbol","symbolKind":"method","extendedModule":"Auth0","externalID":"s:5Auth018CredentialsManagerV6revoke7headersySDyS2SG_tYaKF","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"modules":[{"name":"Auth0"}],"title":"revoke(headers:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"] = [:]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"}]}]},{"kind":"parameters","parameters":[{"name":"headers","content":[{"inlineContent":[{"text":"Additional headers to use when revoking the refresh token.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"syntax":"swift","code":["do {"," try await credentialsManager.revoke()"," print(\"Revoked refresh token and cleared credentials\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom headers for the refresh token revocation:"}]},{"syntax":"swift","code":["try await credentialsManager.revoke(headers: [\"key\": \"value\"])"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If no refresh token is available the endpoint is not called, the credentials are cleared, and no error is thrown."}]},{"style":"note","type":"aside","name":"Throws","content":[{"inlineContent":[{"type":"text","text":"An error of type "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","type":"reference","isActive":true},{"text":".","type":"text"}],"type":"paragraph"}]}]}],"abstract":[{"type":"text","text":"Calls the "},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and an error is thrown."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-6wgai":{"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai","kind":"symbol","title":"revoke(headers:)","type":"topic","abstract":[{"type":"text","text":"Calls the "},{"type":"codeVoice","code":"\/oauth\/revoke"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and an error is thrown."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","role":"symbol"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-9mzo6.json b/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-9mzo6.json index 4316f356..04f1e226 100644 --- a/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-9mzo6.json +++ b/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-9mzo6.json @@ -1 +1 @@ -{"metadata":{"title":"revoke(headers:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsManagerV6revoke7headers7Combine12AnyPublisherVyytAA0bC5ErrorVGSDyS2SG_tF","symbolKind":"method","roleHeading":"Instance Method","role":"symbol","extendedModule":"Auth0","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]) -> "},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"],"title":"Related Documentation"}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Calls the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"] = [:]) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"platforms":["iOS"]}]},{"parameters":[{"name":"headers","content":[{"inlineContent":[{"text":"Additional headers to use when revoking the refresh token.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A type-erased publisher.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"code":["credentialsManager"," .revoke()"," .sink(receiveCompletion: { completion in"," switch completion {"," case .finished:"," print(\"Revoked refresh token and cleared credentials\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: {})"," .store(in: &cancellables)"],"syntax":"swift","type":"codeListing"},{"type":"paragraph","inlineContent":[{"text":"If you need to specify custom headers for the refresh token revocation:","type":"text"}]},{"syntax":"swift","code":["credentialsManager"," .revoke(headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If no refresh token is available the endpoint is not called, the credentials are cleared, and the subscription"},{"text":" ","type":"text"},{"type":"text","text":"completes without an error."}]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6"},"sections":[],"references":{"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"title":"Refresh Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link"},"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","title":"Authentication API Endpoint","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-9mzo6":{"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Calls the "},{"type":"codeVoice","code":"\/oauth\/revoke"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"type":"text","text":" "},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error."}],"title":"revoke(headers:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsManagerV6revoke7headers7Combine12AnyPublisherVyytAA0bC5ErrorVGSDyS2SG_tF","extendedModule":"Auth0","symbolKind":"method","title":"revoke(headers:)"},"sections":[],"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","interfaceLanguage":"swift"},"abstract":[{"text":"Calls the ","type":"text"},{"type":"codeVoice","code":"\/oauth\/revoke"},{"type":"text","text":" endpoint to revoke the refresh token and then clears the credentials if the request"},{"text":" ","type":"text"},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"] = [:]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Additional headers to use when revoking the refresh token."}],"type":"paragraph"}],"name":"headers"}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A type-erased publisher."}]}]},{"kind":"content","content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"syntax":"swift","type":"codeListing","code":["credentialsManager"," .revoke()"," .sink(receiveCompletion: { completion in"," switch completion {"," case .finished:"," print(\"Revoked refresh token and cleared credentials\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: {})"," .store(in: &cancellables)"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom headers for the refresh token revocation:"}]},{"code":["credentialsManager"," .revoke(headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If no refresh token is available the endpoint is not called, the credentials are cleared, and the subscription"},{"text":" ","type":"text"},{"type":"text","text":"completes without an error."}]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-9mzo6":{"type":"topic","role":"symbol","abstract":[{"text":"Calls the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"type":"text","text":" "},{"text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","title":"revoke(headers:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens"},"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/revoke(headers:_:).json b/docs/data/documentation/auth0/credentialsmanager/revoke(headers:_:).json index 95ffc533..2c2197c6 100644 --- a/docs/data/documentation/auth0/credentialsmanager/revoke(headers:_:).json +++ b/docs/data/documentation/auth0/credentialsmanager/revoke(headers:_:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)"},"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"],"title":"Related Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"kind":"symbol","metadata":{"title":"revoke(headers:_:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"], (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"role":"symbol","symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV6revoke7headers_ySDyS2SG_ys6ResultOyytAA0bC5ErrorVGctF","roleHeading":"Instance Method"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"revoke"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"] = [:], ","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"callback"},{"text":": ","kind":"text"},{"kind":"attribute","text":"@escaping"},{"kind":"text","text":" ("},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Additional headers to use when revoking the refresh token."}],"type":"paragraph"}],"name":"headers"},{"content":[{"inlineContent":[{"type":"text","text":"Callback that receives a "},{"code":"Result","type":"codeVoice"},{"type":"text","text":" containing either an empty success case or an error."}],"type":"paragraph"}],"name":"callback"}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"code":["credentialsManager.revoke { result in"," switch result {"," case .success:"," print(\"Revoked refresh token and cleared credentials\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"If you need to specify custom headers for the refresh token revocation:","type":"text"}]},{"code":["credentialsManager.revoke(headers: [\"key\": \"value\"]) { print($0) }"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"If no refresh token is available the endpoint is not called, the credentials are cleared, and the callback is","type":"text"},{"type":"text","text":" "},{"type":"text","text":"invoked with a success case."}]}],"kind":"content"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"Calls the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials will not be cleared and the callback will be called with a failure","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"result containing a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"reference","isActive":true},{"type":"text","text":" error."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","title":"Authentication API Endpoint","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference"},{"text":" can be accessed via the ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"text":" property.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","title":"revokeFailed","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:_:)":{"kind":"symbol","title":"revoke(headers:_:)","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], (","kind":"text"},{"text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"abstract":[{"text":"Calls the ","type":"text"},{"type":"codeVoice","code":"\/oauth\/revoke"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"was successful. Otherwise, the credentials will not be cleared and the callback will be called with a failure"},{"text":" ","type":"text"},{"type":"text","text":"result containing a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","isActive":true},{"text":" error.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult","role":"symbol","type":"topic"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","type":"link"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"metadata":{"externalID":"s:5Auth018CredentialsManagerV6revoke7headers_ySDyS2SG_ys6ResultOyytAA0bC5ErrorVGctF","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","symbolKind":"method","title":"revoke(headers:_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], (","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"Calls the "},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"type":"text","text":" "},{"type":"text","text":"was successful. Otherwise, the credentials will not be cleared and the callback will be called with a failure"},{"type":"text","text":" "},{"type":"text","text":"result containing a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","isActive":true,"type":"reference"},{"text":" error.","type":"text"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"] = [:], ","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"attribute","text":"@escaping"},{"text":" (","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Additional headers to use when revoking the refresh token.","type":"text"}],"type":"paragraph"}],"name":"headers"},{"content":[{"inlineContent":[{"type":"text","text":"Callback that receives a "},{"code":"Result","type":"codeVoice"},{"text":" containing either an empty success case or an error.","type":"text"}],"type":"paragraph"}],"name":"callback"}]},{"kind":"content","content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"syntax":"swift","code":["credentialsManager.revoke { result in"," switch result {"," case .success:"," print(\"Revoked refresh token and cleared credentials\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"If you need to specify custom headers for the refresh token revocation:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["credentialsManager.revoke(headers: [\"key\": \"value\"]) { print($0) }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If no refresh token is available the endpoint is not called, the credentials are cleared, and the callback is"},{"text":" ","type":"text"},{"type":"text","text":"invoked with a success case."}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"type":"topic","kind":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:_:)":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","title":"revoke(headers:_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"], ("},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Calls the "},{"type":"codeVoice","code":"\/oauth\/revoke"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials will not be cleared and the callback will be called with a failure","type":"text"},{"text":" ","type":"text"},{"text":"result containing a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","isActive":true},{"type":"text","text":" error."}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"topic","title":"revokeFailed","abstract":[{"type":"text","text":"The revocation of the refresh token failed."},{"type":"text","text":" "},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":" property.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}]},"https://auth0.com/docs/api/authentication#revoke-refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#revoke-refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/store(credentials:).json b/docs/data/documentation/auth0/credentialsmanager/store(credentials:).json index cd4f4098..c96b97c1 100644 --- a/docs/data/documentation/auth0/credentialsmanager/store(credentials:).json +++ b/docs/data/documentation/auth0/credentialsmanager/store(credentials:).json @@ -1 +1 @@ -{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"store","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"Credentials instance to store.","type":"text"}],"type":"paragraph"}],"name":"credentials"}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the credentials were stored."}]}],"kind":"content"},{"kind":"content","content":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["let didStore = credentialsManager.store(credentials: credentials)"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/store(credentials:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"method","role":"symbol","title":"store(credentials:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"credentials"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV5store11credentialsSbAA0B0C_tF"},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"text":"SDK for Apple platforms.","type":"text"}],"type":"topic","title":"Auth0","url":"\/documentation\/auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","title":"store(credentials:)","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]}}} \ No newline at end of file +{"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"abstract":[{"text":"Stores a credentials instance in the Keychain.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/store(credentials:)"]}],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"externalID":"s:5Auth018CredentialsManagerV5store11credentialsSbAA0B0C_tF","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol","title":"store(credentials:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"credentials","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Credentials instance to store."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","anchor":"return-value","type":"heading","level":2},{"inlineContent":[{"text":"If the credentials were stored.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"type":"codeListing","syntax":"swift","code":["let didStore = credentialsManager.store(credentials: credentials)"]}],"kind":"content"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"text":"credentials","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","kind":"symbol","abstract":[{"type":"text","text":"Stores a credentials instance in the Keychain."}],"type":"topic","role":"symbol","title":"store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/user.json b/docs/data/documentation/auth0/credentialsmanager/user.json index 38c1d7c5..e49ea45b 100644 --- a/docs/data/documentation/auth0/credentialsmanager/user.json +++ b/docs/data/documentation/auth0/credentialsmanager/user.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsManagerV4userAA8UserInfoVSgvp","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"user","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","title":"user","symbolKind":"property","role":"symbol"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"user","kind":"identifier"},{"kind":"text","text":": "},{"text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"syntax":"swift","type":"codeListing","code":["let user = credentialsManager.user"]},{"style":"important","name":"Important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Access to this property will not be protected by biometric authentication."}]}],"type":"aside"}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/user"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired."},{"text":" ","type":"text"},{"type":"text","text":"The user information is read from the stored "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"url":"\/documentation\/auth0\/credentialsmanager\/user","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","type":"topic","abstract":[{"text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The user information is read from the stored "},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","type":"reference","isActive":true},{"text":".","type":"text"}],"kind":"symbol","title":"user","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"user","kind":"identifier"},{"kind":"text","text":": "},{"text":"UserInfo","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":"?"}]},"https://auth0.com/docs/secure/tokens/id-tokens":{"title":"ID token","titleInlineContent":[{"text":"ID token","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"type":"topic","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"user"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["let user = credentialsManager.user"]},{"type":"aside","content":[{"inlineContent":[{"text":"Access to this property will not be protected by biometric authentication.","type":"text"}],"type":"paragraph"}],"style":"important","name":"Important"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"abstract":[{"type":"text","text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired."},{"type":"text","text":" "},{"text":"The user information is read from the stored ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"},{"text":".","type":"text"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/user"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth018CredentialsManagerV4userAA8UserInfoVSgvp","title":"user","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"user","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo","kind":"typeIdentifier"},{"kind":"text","text":"?"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","type":"topic","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/user","abstract":[{"type":"text","text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired."},{"text":" ","type":"text"},{"type":"text","text":"The user information is read from the stored "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","isActive":true},{"text":".","type":"text"}],"kind":"symbol","title":"user"},"https://auth0.com/docs/secure/tokens/id-tokens":{"title":"ID token","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","titleInlineContent":[{"type":"text","text":"ID token"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"url":"\/documentation\/auth0\/credentialsmanager","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"topic","title":"CredentialsManager","abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror.json b/docs/data/documentation/auth0/credentialsmanagererror.json index b3962fb7..100d5dd5 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror.json +++ b/docs/data/documentation/auth0/credentialsmanagererror.json @@ -1 +1 @@ -{"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP"],"type":"conformsTo"}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe"],"title":"Operators"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription"],"title":"Instance Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed"],"title":"Type Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations"],"generated":true,"title":"Default Implementations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror"]}],"metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"externalID":"s:5Auth023CredentialsManagerErrorV","symbolKind":"struct","title":"CredentialsManagerError","roleHeading":"Structure","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"role":"symbol"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}]}],"kind":"declarations"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"role":"collectionGroup","url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations","type":"topic","abstract":[],"kind":"article","title":"Auth0Error Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/storeFailed":{"url":"\/documentation\/auth0\/credentialsmanagererror\/storefailed","role":"symbol","type":"topic","title":"storeFailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","abstract":[{"text":"Storing the renewed credentials failed.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":"."}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/s5ErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true,"type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/renewFailed":{"title":"renewFailed","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed","type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/renewfailed","abstract":[{"type":"text","text":"The credentials renewal failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"type":"text","text":" can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":" property.","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renewFailed","kind":"identifier"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","type":"topic","abstract":[],"title":"Equatable Implementations","kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations"},"https://manage.auth0.com/#/apis/":{"url":"https:\/\/manage.auth0.com\/#\/apis\/","titleInlineContent":[{"text":"Auth0 API","type":"text"}],"title":"Auth0 API","identifier":"https:\/\/manage.auth0.com\/#\/apis\/","type":"link"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","kind":"article","role":"collectionGroup","title":"LocalizedError Implementations"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"title":"Foundation.LocalizedError","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/cause":{"url":"\/documentation\/auth0\/credentialsmanagererror\/cause","role":"symbol","title":"cause","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"?","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-93ixe":{"kind":"symbol","title":"~=(_:_:)","role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","abstract":[{"text":"Matches ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference"},{"text":" can be accessed via the ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"text":" property.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","title":"revokeFailed","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-7k0od":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","type":"topic","abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"CredentialsManagerError"},{"type":"text","text":" values in a switch statement."}],"kind":"symbol","title":"~=(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noCredentials":{"kind":"symbol","title":"noCredentials","role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"noCredentials"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"type":"topic","abstract":[{"text":"No credentials were found in the store.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/biometricsFailed":{"kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"biometricsFailed"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"title":"biometricsFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","type":"topic","abstract":[{"text":"The biometric authentication failed.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"LAError","type":"codeVoice"},{"type":"text","text":" can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/largeMinTTL":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"largeMinTTL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"The "},{"type":"codeVoice","code":"minTTL"},{"type":"text","text":" requested is greater than the lifetime of the renewed access token. Request a lower "},{"code":"minTTL","type":"codeVoice"},{"text":" or","type":"text"},{"type":"text","text":" "},{"text":"increase the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Token Expiration","type":"text"}]},{"text":" value in the settings page of your ","type":"text"},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis\/","type":"reference"},{"type":"text","text":"."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/largeminttl","role":"symbol","type":"topic","title":"largeMinTTL","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/debugDescription":{"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","type":"topic","abstract":[{"text":"Description of the error.","type":"text"}],"title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol"}}} \ No newline at end of file +{"kind":"symbol","relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP"],"type":"conformsTo","kind":"relationships","title":"Conforms To"}],"metadata":{"roleHeading":"Structure","role":"symbol","externalID":"s:5Auth023CredentialsManagerErrorV","symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror"]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe"],"title":"Operators"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription"],"title":"Instance Properties"},{"title":"Type Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations"],"generated":true,"title":"Default Implementations"}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/cause":{"url":"\/documentation\/auth0\/credentialsmanagererror\/cause","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"title":"cause","role":"symbol","type":"topic","abstract":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-93ixe":{"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","abstract":[{"type":"text","text":"Matches "},{"code":"Error","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe","title":"~=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/storeFailed":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"storeFailed"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"abstract":[{"text":"Storing the renewed credentials failed.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/storefailed","kind":"symbol","title":"storeFailed"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/biometricsFailed":{"abstract":[{"type":"text","text":"The biometric authentication failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"LAError","type":"codeVoice"},{"text":" can be accessed via the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":" property.","type":"text"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"biometricsFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","title":"biometricsFailed","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/debugDescription":{"url":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","abstract":[{"text":"Description of the error.","type":"text"}],"title":"debugDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"title":"Equatable Implementations","url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","type":"topic","role":"collectionGroup"},"https://manage.auth0.com/#/apis/":{"titleInlineContent":[{"type":"text","text":"Auth0 API"}],"identifier":"https:\/\/manage.auth0.com\/#\/apis\/","type":"link","url":"https:\/\/manage.auth0.com\/#\/apis\/","title":"Auth0 API"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"topic","title":"revokeFailed","abstract":[{"type":"text","text":"The revocation of the refresh token failed."},{"type":"text","text":" "},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":" property.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable","title":"Swift.Error"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"url":"\/documentation\/auth0\/auth0error","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"kind":"symbol","title":"Auth0Error"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"text":" instance does not contain a refresh token.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/largeMinTTL":{"url":"\/documentation\/auth0\/credentialsmanagererror\/largeminttl","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"largeMinTTL"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"The "},{"code":"minTTL","type":"codeVoice"},{"text":" requested is greater than the lifetime of the renewed access token. Request a lower ","type":"text"},{"type":"codeVoice","code":"minTTL"},{"text":" or","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"increase the "},{"type":"strong","inlineContent":[{"type":"text","text":"Token Expiration"}]},{"type":"text","text":" value in the settings page of your "},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis\/","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","title":"largeMinTTL","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-7k0od":{"url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"CredentialsManagerError"},{"type":"text","text":" values in a switch statement."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","title":"~=(_:_:)","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","title":"Auth0Error Implementations","role":"collectionGroup","type":"topic","abstract":[],"kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noCredentials":{"abstract":[{"type":"text","text":"No credentials were found in the store."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"noCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"role":"symbol","type":"topic","kind":"symbol","title":"noCredentials","url":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/renewFailed":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renewFailed","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"title":"renewFailed","role":"symbol","type":"topic","kind":"symbol","abstract":[{"text":"The credentials renewal failed.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"The underlying "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"type":"text","text":" can be accessed via the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":" property."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/renewfailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","abstract":[],"title":"LocalizedError Implementations","kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"type":"unresolvable","title":"Swift.CustomDebugStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/!=(_:_:).json b/docs/data/documentation/auth0/credentialsmanagererror/!=(_:_:).json index 5114e906..498bef48 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/!=(_:_:).json +++ b/docs/data/documentation/auth0/credentialsmanagererror/!=(_:_:).json @@ -1 +1 @@ -{"metadata":{"role":"symbol","extendedModule":"Swift","symbolKind":"op","roleHeading":"Operator","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"!=(_:_:)","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","modules":[{"name":"Auth0","relatedModules":["Swift"]}]},"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"platforms":["iOS"],"languages":["swift"]}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/!=(_:_:)":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","type":"topic","abstract":[],"title":"!=(_:_:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","type":"topic","abstract":[],"title":"Equatable Implementations","kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)"},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"extendedModule":"Swift","title":"!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"modules":[{"name":"Auth0","relatedModules":["Swift"]}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","roleHeading":"Operator","role":"symbol","symbolKind":"op"},"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/!=(_:_:)":{"title":"!=(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)","abstract":[],"kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"title":"Equatable Implementations","url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","type":"topic","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/==(_:_:).json b/docs/data/documentation/auth0/credentialsmanagererror/==(_:_:).json index 11f068c1..3cbcfea6 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/==(_:_:).json +++ b/docs/data/documentation/auth0/credentialsmanagererror/==(_:_:).json @@ -1 +1 @@ -{"abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"modules":[{"name":"Auth0"}],"title":"==(_:_:)","extendedModule":"Auth0","symbolKind":"op","externalID":"s:5Auth023CredentialsManagerErrorV2eeoiySbAC_ACtFZ","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"=="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"roleHeading":"Operator","role":"symbol"},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations"]]},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","type":"topic","abstract":[],"title":"Equatable Implementations","kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/==(_:_:)":{"url":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","type":"topic","kind":"symbol","role":"symbol","title":"==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"=="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)"]}],"abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"title":"==(_:_:)","extendedModule":"Auth0","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Operator","symbolKind":"op","externalID":"s:5Auth023CredentialsManagerErrorV2eeoiySbAC_ACtFZ","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"=="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"title":"Equatable Implementations","url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","type":"topic","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/==(_:_:)":{"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"role":"symbol","title":"==(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/auth0error-implementations.json b/docs/data/documentation/auth0/credentialsmanagererror/auth0error-implementations.json index 584a2e32..46742f12 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/auth0error-implementations.json @@ -1 +1 @@ -{"metadata":{"roleHeading":"API Collection","title":"Auth0Error Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations"},"topicSections":[{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription"]}],"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/localizedDescription":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription","type":"topic","abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","title":"localizedDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/errorDescription":{"url":"\/documentation\/auth0\/credentialsmanagererror\/errordescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"title":"errorDescription"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"kind":"article","topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription"],"generated":true}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"title":"Auth0Error Implementations","modules":[{"name":"Auth0"}],"role":"collectionGroup","roleHeading":"API Collection"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/errorDescription":{"url":"\/documentation\/auth0\/credentialsmanagererror\/errordescription","kind":"symbol","title":"errorDescription","type":"topic","abstract":[{"type":"text","text":"Description of the error."}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/localizedDescription":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription","title":"localizedDescription","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/biometricsfailed.json b/docs/data/documentation/auth0/credentialsmanagererror/biometricsfailed.json index 636886b2..a5890703 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/biometricsfailed.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/biometricsfailed.json @@ -1 +1 @@ -{"abstract":[{"text":"The biometric authentication failed.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"LAError","type":"codeVoice"},{"text":" can be accessed via the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":" property."}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"biometricsFailed"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","text":"CredentialsManagerError"}],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"biometricsFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"roleHeading":"Type Property","externalID":"s:5Auth023CredentialsManagerErrorV16biometricsFailedACvpZ","title":"biometricsFailed"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/biometricsFailed":{"kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"biometricsFailed"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"title":"biometricsFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","type":"topic","abstract":[{"text":"The biometric authentication failed.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"LAError","type":"codeVoice"},{"type":"text","text":" can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"biometricsFailed"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"platforms":["iOS"]}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"biometricsFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"role":"symbol","externalID":"s:5Auth023CredentialsManagerErrorV16biometricsFailedACvpZ","symbolKind":"property","roleHeading":"Type Property","title":"biometricsFailed"},"abstract":[{"type":"text","text":"The biometric authentication failed."},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"LAError","type":"codeVoice"},{"text":" can be accessed via the ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/biometricsFailed":{"abstract":[{"type":"text","text":"The biometric authentication failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"LAError","type":"codeVoice"},{"text":" can be accessed via the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":" property.","type":"text"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"biometricsFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","title":"biometricsFailed","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/cause.json b/docs/data/documentation/auth0/credentialsmanagererror/cause.json index 951c706f..7385f5b4 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/cause.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/cause.json @@ -1 +1 @@ -{"abstract":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/cause"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"title":"cause","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth023CredentialsManagerErrorV5causes0D0_pSgvp","roleHeading":"Instance Property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/cause":{"url":"\/documentation\/auth0\/credentialsmanagererror\/cause","role":"symbol","title":"cause","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"?","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"externalID":"s:5Auth023CredentialsManagerErrorV5causes0D0_pSgvp","role":"symbol","title":"cause","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause"},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/cause"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/cause":{"url":"\/documentation\/auth0\/credentialsmanagererror\/cause","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"title":"cause","role":"symbol","type":"topic","abstract":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/debugdescription.json b/docs/data/documentation/auth0/credentialsmanagererror/debugdescription.json index 2c0d011d..083e8e5f 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/debugdescription.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/debugdescription.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription"},"metadata":{"title":"debugDescription","externalID":"s:5Auth023CredentialsManagerErrorV16debugDescriptionSSvp","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"name":"Important","content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"text":" only.","type":"text"}]}],"type":"aside","style":"important"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/debugdescription"]}],"abstract":[{"text":"Description of the error.","type":"text"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/debugDescription":{"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","type":"topic","abstract":[{"text":"Description of the error.","type":"text"}],"title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"name":"Important","content":[{"inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"text":" only.","type":"text"}],"type":"paragraph"}],"type":"aside","style":"important"}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription"},"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth023CredentialsManagerErrorV16debugDescriptionSSvp","title":"debugDescription","roleHeading":"Instance Property"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/debugdescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/debugDescription":{"url":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","abstract":[{"text":"Description of the error.","type":"text"}],"title":"debugDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/equatable-implementations.json b/docs/data/documentation/auth0/credentialsmanagererror/equatable-implementations.json index f5ea4ca7..7296a5db 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/equatable-implementations.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/equatable-implementations.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"title":"Equatable Implementations","roleHeading":"API Collection","role":"collectionGroup"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)"],"generated":true}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","interfaceLanguage":"swift"},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/!=(_:_:)":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","type":"topic","abstract":[],"title":"!=(_:_:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/==(_:_:)":{"url":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","type":"topic","kind":"symbol","role":"symbol","title":"==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations"]}],"topicSections":[{"generated":true,"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)"]}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"article","metadata":{"modules":[{"name":"Auth0"}],"title":"Equatable Implementations","role":"collectionGroup","roleHeading":"API Collection"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/!=(_:_:)":{"title":"!=(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)","abstract":[],"kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/==(_:_:)":{"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"role":"symbol","title":"==(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/errordescription.json b/docs/data/documentation/auth0/credentialsmanagererror/errordescription.json index 50895d4d..82c774c4 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/errordescription.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/errordescription.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"type":"aside","style":"important","name":"Important","content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"type":"text","text":" only."}]}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/errordescription"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"extendedModule":"Auth0","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","symbolKind":"property","role":"symbol","title":"errorDescription"},"kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"role":"collectionGroup","url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations","type":"topic","abstract":[],"kind":"article","title":"Auth0Error Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/errorDescription":{"url":"\/documentation\/auth0\/credentialsmanagererror\/errordescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"title":"errorDescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"metadata":{"role":"symbol","symbolKind":"property","title":"errorDescription","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"extendedModule":"Auth0","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"type":"aside","name":"Important","content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"text":" only.","type":"text"}],"type":"paragraph"}],"style":"important"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/errordescription"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription"},"sections":[],"abstract":[{"text":"Description of the error.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/errorDescription":{"url":"\/documentation\/auth0\/credentialsmanagererror\/errordescription","kind":"symbol","title":"errorDescription","type":"topic","abstract":[{"type":"text","text":"Description of the error."}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","title":"Auth0Error Implementations","role":"collectionGroup","type":"topic","abstract":[],"kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/failurereason.json b/docs/data/documentation/auth0/credentialsmanagererror/failurereason.json index daacfd8a..800d6610 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/failurereason.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/failurereason.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/failurereason"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"extendedModule":"Foundation","roleHeading":"Instance Property","externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","platforms":[{"unavailable":false,"introducedAt":"8.0","name":"iOS","deprecated":false,"beta":false},{"unavailable":false,"introducedAt":"10.10","deprecated":false,"name":"macOS","beta":false},{"unavailable":false,"introducedAt":"9.0","deprecated":false,"name":"tvOS","beta":false},{"name":"watchOS","introducedAt":"2.0","beta":false,"deprecated":false,"unavailable":false}],"title":"failureReason","role":"symbol","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","interfaceLanguage":"swift"},"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","kind":"article","role":"collectionGroup","title":"LocalizedError Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/failureReason":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","abstract":[],"title":"failureReason","role":"symbol","kind":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/failurereason"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations"]]},"metadata":{"title":"failureReason","platforms":[{"deprecated":false,"introducedAt":"8.0","unavailable":false,"name":"iOS","beta":false},{"introducedAt":"10.10","deprecated":false,"unavailable":false,"beta":false,"name":"macOS"},{"beta":false,"deprecated":false,"name":"tvOS","introducedAt":"9.0","unavailable":false},{"introducedAt":"2.0","unavailable":false,"beta":false,"name":"watchOS","deprecated":false}],"symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","roleHeading":"Instance Property","extendedModule":"Foundation","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"role":"symbol"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/failurereason"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/failureReason":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","abstract":[],"title":"failureReason","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/failurereason","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","abstract":[],"title":"LocalizedError Implementations","kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","role":"collectionGroup"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/helpanchor.json b/docs/data/documentation/auth0/credentialsmanagererror/helpanchor.json index b47b0e3a..09c9136d 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/helpanchor.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/helpanchor.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"text":".","type":"text"}],"sections":[],"metadata":{"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"platforms":[{"beta":false,"name":"iOS","deprecated":false,"introducedAt":"8.0","unavailable":false},{"introducedAt":"10.10","deprecated":false,"name":"macOS","beta":false,"unavailable":false},{"beta":false,"name":"tvOS","unavailable":false,"deprecated":false,"introducedAt":"9.0"},{"name":"watchOS","unavailable":false,"beta":false,"introducedAt":"2.0","deprecated":false}],"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"extendedModule":"Foundation","roleHeading":"Instance Property","role":"symbol","title":"helpAnchor","symbolKind":"property"},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","kind":"article","role":"collectionGroup","title":"LocalizedError Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/helpAnchor":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","kind":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"abstract":[],"url":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","title":"helpAnchor","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"text":".","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/helpanchor"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations"]]},"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"helpAnchor","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"platforms":[{"name":"iOS","deprecated":false,"unavailable":false,"introducedAt":"8.0","beta":false},{"deprecated":false,"name":"macOS","beta":false,"unavailable":false,"introducedAt":"10.10"},{"deprecated":false,"introducedAt":"9.0","name":"tvOS","beta":false,"unavailable":false},{"unavailable":false,"introducedAt":"2.0","beta":false,"name":"watchOS","deprecated":false}],"extendedModule":"Foundation","role":"symbol","symbolKind":"property","roleHeading":"Instance Property","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/helpAnchor":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","kind":"symbol","role":"symbol","title":"helpAnchor","type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","abstract":[],"title":"LocalizedError Implementations","kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/largeminttl.json b/docs/data/documentation/auth0/credentialsmanagererror/largeminttl.json index 21514843..fc251bcd 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/largeminttl.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/largeminttl.json @@ -1 +1 @@ -{"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"largeMinTTL","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"}],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"The "},{"code":"minTTL","type":"codeVoice"},{"type":"text","text":" requested is greater than the lifetime of the renewed access token. Request a lower "},{"code":"minTTL","type":"codeVoice"},{"type":"text","text":" or"},{"text":" ","type":"text"},{"text":"increase the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Token Expiration","type":"text"}]},{"type":"text","text":" value in the settings page of your "},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis\/"},{"type":"text","text":"."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/largeminttl"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","interfaceLanguage":"swift"},"metadata":{"title":"largeMinTTL","modules":[{"name":"Auth0"}],"roleHeading":"Type Property","role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"largeMinTTL"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"externalID":"s:5Auth023CredentialsManagerErrorV11largeMinTTLACvpZ"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://manage.auth0.com/#/apis/":{"url":"https:\/\/manage.auth0.com\/#\/apis\/","identifier":"https:\/\/manage.auth0.com\/#\/apis\/","type":"link","title":"Auth0 API","titleInlineContent":[{"type":"text","text":"Auth0 API"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/largeMinTTL":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"largeMinTTL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"The "},{"type":"codeVoice","code":"minTTL"},{"type":"text","text":" requested is greater than the lifetime of the renewed access token. Request a lower "},{"code":"minTTL","type":"codeVoice"},{"text":" or","type":"text"},{"type":"text","text":" "},{"text":"increase the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Token Expiration","type":"text"}]},{"text":" value in the settings page of your ","type":"text"},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis\/","type":"reference"},{"type":"text","text":"."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/largeminttl","role":"symbol","type":"topic","title":"largeMinTTL","kind":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/largeminttl"]}],"abstract":[{"type":"text","text":"The "},{"type":"codeVoice","code":"minTTL"},{"type":"text","text":" requested is greater than the lifetime of the renewed access token. Request a lower "},{"type":"codeVoice","code":"minTTL"},{"type":"text","text":" or"},{"text":" ","type":"text"},{"type":"text","text":"increase the "},{"type":"strong","inlineContent":[{"type":"text","text":"Token Expiration"}]},{"text":" value in the settings page of your ","type":"text"},{"identifier":"https:\/\/manage.auth0.com\/#\/apis\/","isActive":true,"type":"reference"},{"type":"text","text":"."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"largeMinTTL","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","kind":"typeIdentifier"}]}],"kind":"declarations"}],"metadata":{"symbolKind":"property","title":"largeMinTTL","externalID":"s:5Auth023CredentialsManagerErrorV11largeMinTTLACvpZ","role":"symbol","roleHeading":"Type Property","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"largeMinTTL","kind":"identifier"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","interfaceLanguage":"swift"},"sections":[],"references":{"https://manage.auth0.com/#/apis/":{"titleInlineContent":[{"type":"text","text":"Auth0 API"}],"type":"link","url":"https:\/\/manage.auth0.com\/#\/apis\/","title":"Auth0 API","identifier":"https:\/\/manage.auth0.com\/#\/apis\/"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/largeMinTTL":{"url":"\/documentation\/auth0\/credentialsmanagererror\/largeminttl","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"largeMinTTL"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"The "},{"code":"minTTL","type":"codeVoice"},{"text":" requested is greater than the lifetime of the renewed access token. Request a lower ","type":"text"},{"type":"codeVoice","code":"minTTL"},{"text":" or","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"increase the "},{"type":"strong","inlineContent":[{"type":"text","text":"Token Expiration"}]},{"type":"text","text":" value in the settings page of your "},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis\/","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","title":"largeMinTTL","role":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/localizeddescription.json b/docs/data/documentation/auth0/credentialsmanagererror/localizeddescription.json index 95986c93..ccb3d912 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/localizeddescription.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/localizeddescription.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Description of the error."}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"aside","style":"important","content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"text":" only.","type":"text"}],"type":"paragraph"}],"name":"Important"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"roleHeading":"Instance Property","title":"localizedDescription","modules":[{"name":"Auth0"}],"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","extendedModule":"Auth0"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/localizeddescription"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"role":"collectionGroup","url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations","type":"topic","abstract":[],"kind":"article","title":"Auth0Error Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/localizedDescription":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription","type":"topic","abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","title":"localizedDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations"]]},"metadata":{"extendedModule":"Auth0","role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"localizedDescription"},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Description of the error.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"discussion","text":"Discussion","level":2},{"style":"important","name":"Important","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"text":" only.","type":"text"}]}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/localizedDescription":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription","title":"localizedDescription","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","title":"Auth0Error Implementations","role":"collectionGroup","type":"topic","abstract":[],"kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/localizederror-implementations.json b/docs/data/documentation/auth0/credentialsmanagererror/localizederror-implementations.json index 922b9432..f86a70e3 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/localizederror-implementations.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/localizederror-implementations.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"role":"collectionGroup","title":"LocalizedError Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"kind":"article","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion"],"generated":true,"title":"Instance Properties"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/recoverySuggestion":{"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"abstract":[],"role":"symbol","type":"topic","title":"recoverySuggestion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","url":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/failureReason":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","abstract":[],"title":"failureReason","role":"symbol","kind":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/failurereason"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/helpAnchor":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","kind":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"abstract":[],"url":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","title":"helpAnchor","role":"symbol"}}} \ No newline at end of file +{"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations"},"metadata":{"title":"LocalizedError Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"topicSections":[{"generated":true,"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/failureReason":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","abstract":[],"title":"failureReason","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/failurereason","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/recoverySuggestion":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion","title":"recoverySuggestion","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","role":"symbol","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/helpAnchor":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","kind":"symbol","role":"symbol","title":"helpAnchor","type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/nocredentials.json b/docs/data/documentation/auth0/credentialsmanagererror/nocredentials.json index 7ed100ae..a9cbf0a9 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/nocredentials.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/nocredentials.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"noCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"No credentials were found in the store."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/nocredentials"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","metadata":{"title":"noCredentials","externalID":"s:5Auth023CredentialsManagerErrorV02noB0ACvpZ","role":"symbol","symbolKind":"property","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noCredentials","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"modules":[{"name":"Auth0"}],"roleHeading":"Type Property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noCredentials":{"kind":"symbol","title":"noCredentials","role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"noCredentials"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"type":"topic","abstract":[{"text":"No credentials were found in the store.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/nocredentials"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"noCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"symbolKind":"property","roleHeading":"Type Property","title":"noCredentials","externalID":"s:5Auth023CredentialsManagerErrorV02noB0ACvpZ","modules":[{"name":"Auth0"}],"role":"symbol"},"kind":"symbol","abstract":[{"text":"No credentials were found in the store.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"noCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noCredentials":{"abstract":[{"type":"text","text":"No credentials were found in the store."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"noCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"role":"symbol","type":"topic","kind":"symbol","title":"noCredentials","url":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/norefreshtoken.json b/docs/data/documentation/auth0/credentialsmanagererror/norefreshtoken.json index 5247a75c..9520b250 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/norefreshtoken.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/norefreshtoken.json @@ -1 +1 @@ -{"abstract":[{"text":"The stored ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance does not contain a refresh token."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"externalID":"s:5Auth023CredentialsManagerErrorV14noRefreshTokenACvpZ","symbolKind":"property","roleHeading":"Type Property","role":"symbol","title":"noRefreshToken"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true,"type":"reference"},{"type":"text","text":" instance does not contain a refresh token."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"kind":"symbol","metadata":{"symbolKind":"property","title":"noRefreshToken","externalID":"s:5Auth023CredentialsManagerErrorV14noRefreshTokenACvpZ","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Type Property","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"abstract":[{"type":"text","text":"The stored "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"type":"text","text":" instance does not contain a refresh token."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"text":" instance does not contain a refresh token.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/recoverysuggestion.json b/docs/data/documentation/auth0/credentialsmanagererror/recoverysuggestion.json index 8aee51e0..5ff9c32e 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/recoverysuggestion.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion"},"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"extendedModule":"Foundation","externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","title":"recoverySuggestion","platforms":[{"introducedAt":"8.0","name":"iOS","unavailable":false,"beta":false,"deprecated":false},{"name":"macOS","unavailable":false,"deprecated":false,"introducedAt":"10.10","beta":false},{"deprecated":false,"beta":false,"name":"tvOS","introducedAt":"9.0","unavailable":false},{"introducedAt":"2.0","unavailable":false,"beta":false,"deprecated":false,"name":"watchOS"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"symbolKind":"property","role":"symbol"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.recoverySuggestion"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/recoverySuggestion":{"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"abstract":[],"role":"symbol","type":"topic","title":"recoverySuggestion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","url":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","kind":"article","role":"collectionGroup","title":"LocalizedError Implementations"}}} \ No newline at end of file +{"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"recoverySuggestion","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"extendedModule":"Foundation","symbolKind":"property","roleHeading":"Instance Property","role":"symbol","platforms":[{"unavailable":false,"introducedAt":"8.0","name":"iOS","deprecated":false,"beta":false},{"beta":false,"name":"macOS","deprecated":false,"introducedAt":"10.10","unavailable":false},{"unavailable":false,"introducedAt":"9.0","beta":false,"name":"tvOS","deprecated":false},{"unavailable":false,"beta":false,"deprecated":false,"introducedAt":"2.0","name":"watchOS"}],"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations"]]},"sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/recoverySuggestion":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion","title":"recoverySuggestion","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","role":"symbol","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","abstract":[],"title":"LocalizedError Implementations","kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/renewfailed.json b/docs/data/documentation/auth0/credentialsmanagererror/renewfailed.json index e5c4c98e..9988c5af 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/renewfailed.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/renewfailed.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/renewfailed"]}],"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renewFailed","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}]}]}],"metadata":{"roleHeading":"Type Property","title":"renewFailed","externalID":"s:5Auth023CredentialsManagerErrorV11renewFailedACvpZ","role":"symbol","symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"renewFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"The credentials renewal failed."},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":" property."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/renewFailed":{"title":"renewFailed","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed","type":"topic","url":"\/documentation\/auth0\/credentialsmanagererror\/renewfailed","abstract":[{"type":"text","text":"The credentials renewal failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"type":"text","text":" can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":" property.","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renewFailed","kind":"identifier"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renewFailed"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/renewfailed"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"The credentials renewal failed.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed"},"metadata":{"roleHeading":"Type Property","role":"symbol","symbolKind":"property","externalID":"s:5Auth023CredentialsManagerErrorV11renewFailedACvpZ","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"renewFailed"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"modules":[{"name":"Auth0"}],"title":"renewFailed"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/renewFailed":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renewFailed","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"title":"renewFailed","role":"symbol","type":"topic","kind":"symbol","abstract":[{"text":"The credentials renewal failed.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"The underlying "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"type":"text","text":" can be accessed via the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":" property."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/renewfailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/revokefailed.json b/docs/data/documentation/auth0/credentialsmanagererror/revokefailed.json index 4842c34d..c2c262e3 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/revokefailed.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/revokefailed.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"kind":"symbol","metadata":{"symbolKind":"property","title":"revokeFailed","externalID":"s:5Auth023CredentialsManagerErrorV12revokeFailedACvpZ","role":"symbol","roleHeading":"Type Property","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/revokefailed"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":" property."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference"},{"text":" can be accessed via the ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"text":" property.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","title":"revokeFailed","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV12revokeFailedACvpZ","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revokeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"title":"revokeFailed","role":"symbol","roleHeading":"Type Property","symbolKind":"property","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/revokefailed"]}],"kind":"symbol","abstract":[{"type":"text","text":"The revocation of the refresh token failed."},{"type":"text","text":" "},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"type":"text","text":" can be accessed via the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":" property."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"topic","title":"revokeFailed","abstract":[{"type":"text","text":"The revocation of the refresh token failed."},{"type":"text","text":" "},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":" property.","type":"text"}],"role":"symbol","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/storefailed.json b/docs/data/documentation/auth0/credentialsmanagererror/storefailed.json index 9cc78bbc..644558d1 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/storefailed.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/storefailed.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Storing the renewed credentials failed."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"text":".","type":"text"}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Type Property","symbolKind":"property","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","externalID":"s:5Auth023CredentialsManagerErrorV11storeFailedACvpZ","modules":[{"name":"Auth0"}],"title":"storeFailed"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/storefailed"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/storeFailed":{"url":"\/documentation\/auth0\/credentialsmanagererror\/storefailed","role":"symbol","type":"topic","title":"storeFailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","abstract":[{"text":"Storing the renewed credentials failed.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":"."}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Storing the renewed credentials failed."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"text":".","type":"text"}],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"metadata":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"storeFailed"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"roleHeading":"Type Property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth023CredentialsManagerErrorV11storeFailedACvpZ","role":"symbol","symbolKind":"property","title":"storeFailed"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/storefailed"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/storeFailed":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"storeFailed"},{"kind":"text","text":": "},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"abstract":[{"text":"Storing the renewed credentials failed.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/storefailed","kind":"symbol","title":"storeFailed"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-7k0od.json b/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-7k0od.json index fb9f4c26..e8a7bff8 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-7k0od.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-7k0od.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"abstract":[{"type":"text","text":"Matches "},{"code":"CredentialsManagerError","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od"]}],"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]}],"kind":"declarations"}],"metadata":{"extendedModule":"Auth0","role":"symbol","roleHeading":"Operator","externalID":"s:5Auth023CredentialsManagerErrorV2teoiySbAC_ACtFZ","symbolKind":"op","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"~=(_:_:)","modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-7k0od":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","type":"topic","abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"CredentialsManagerError"},{"type":"text","text":" values in a switch statement."}],"kind":"symbol","title":"~=(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"CredentialsManagerError"},{"text":" values in a switch statement.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV2teoiySbAC_ACtFZ","title":"~=(_:_:)","roleHeading":"Operator","role":"symbol","symbolKind":"op","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-7k0od":{"url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"CredentialsManagerError"},{"type":"text","text":" values in a switch statement."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","title":"~=(_:_:)","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-93ixe.json b/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-93ixe.json index f88bd5f8..e51fa63a 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-93ixe.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-93ixe.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV2teoiySbAC_s0D0_ptFZ","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"symbolKind":"op","roleHeading":"Operator","title":"~=(_:_:)","role":"symbol","extendedModule":"Auth0","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"sections":[],"abstract":[{"type":"text","text":"Matches "},{"code":"Error","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"lhs","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-93ixe":{"kind":"symbol","title":"~=(_:_:)","role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","abstract":[{"text":"Matches ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","text":"CredentialsManagerError"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}],"kind":"declarations"}],"abstract":[{"text":"Matches ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"sections":[],"metadata":{"roleHeading":"Operator","extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth023CredentialsManagerErrorV2teoiySbAC_s0D0_ptFZ","title":"~=(_:_:)","symbolKind":"op"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-93ixe":{"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","abstract":[{"type":"text","text":"Matches "},{"code":"Error","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe","title":"~=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagerresult.json b/docs/data/documentation/auth0/credentialsmanagerresult.json index 45e659cc..088f2b02 100644 --- a/docs/data/documentation/auth0/credentialsmanagerresult.json +++ b/docs/data/documentation/auth0/credentialsmanagerresult.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManagerResult"},{"text":"<","kind":"text"},{"kind":"genericParameter","text":"T"},{"text":"> = ","kind":"text"},{"preciseIdentifier":"s:s6ResultO","text":"Result","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta1Txmfp","text":"T","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagerresult"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"typealias","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsManagerResult"}],"roleHeading":"Type Alias","externalID":"s:5Auth024CredentialsManagerResulta","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"title":"CredentialsManagerResult"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"url":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagerresult"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"symbolKind":"typealias","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerResult"}],"title":"CredentialsManagerResult","modules":[{"name":"Auth0"}],"roleHeading":"Type Alias","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerResult"}],"externalID":"s:5Auth024CredentialsManagerResulta","role":"symbol"},"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"kind":"text","text":"> = "},{"text":"Result","kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta1Txmfp"},{"kind":"text","text":", "},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}],"url":"\/documentation\/auth0\/credentialsmanagererror","role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"Represents an error during a Credentials Manager operation.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"type":"topic","kind":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsstorage.json b/docs/data/documentation/auth0/credentialsstorage.json index 7394de1a..6c191292 100644 --- a/docs/data/documentation/auth0/credentialsstorage.json +++ b/docs/data/documentation/auth0/credentialsstorage.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"CredentialsStorage","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"paths":["\/documentation\/auth0\/credentialsstorage"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},"metadata":{"symbolKind":"protocol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"externalID":"s:5Auth018CredentialsStorageP","roleHeading":"Protocol","role":"symbol","modules":[{"name":"Auth0"}],"title":"CredentialsStorage"},"sections":[],"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"],"type":"conformingTypes","title":"Conforming Types"}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/deleteEntry(forKey:)":{"url":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)","title":"deleteEntry(forKey:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"required":true,"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","kind":"symbol","abstract":[{"type":"text","text":"Deletes a storage entry."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/getEntry(forKey:)":{"kind":"symbol","url":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEntry"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"Retrieves a storage entry."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","type":"topic","role":"symbol","required":true,"title":"getEntry(forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"url":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/setEntry(_:forKey:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"setEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Sets a storage entry."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","title":"setEntry(_:forKey:)","required":true,"role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","navigatorTitle":[{"text":"SimpleKeychain","kind":"identifier"}],"title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},{"text":".","type":"text"}]}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"],"kind":"relationships","type":"conformingTypes","title":"Conforming Types"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"metadata":{"title":"CredentialsStorage","roleHeading":"Protocol","symbolKind":"protocol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CredentialsStorage"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsStorageP","role":"symbol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)"],"title":"Instance Methods"}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"CredentialsStorage","kind":"identifier"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsstorage"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[{"type":"text","text":"Conformance to "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","title":"CredentialsStorage"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/getEntry(forKey:)":{"type":"topic","abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"kind":"symbol","required":true,"title":"getEntry(forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","url":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getEntry"},{"kind":"text","text":"("},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/deleteEntry(forKey:)":{"kind":"symbol","type":"topic","title":"deleteEntry(forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","abstract":[{"type":"text","text":"Deletes a storage entry."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"required":true,"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/setEntry(_:forKey:)":{"url":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"setEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"setEntry(_:forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","kind":"symbol","role":"symbol","required":true,"type":"topic","abstract":[{"text":"Sets a storage entry.","type":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsstorage/deleteentry(forkey:).json b/docs/data/documentation/auth0/credentialsstorage/deleteentry(forkey:).json index 6da2e886..0959ffd2 100644 --- a/docs/data/documentation/auth0/credentialsstorage/deleteentry(forkey:).json +++ b/docs/data/documentation/auth0/credentialsstorage/deleteentry(forkey:).json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Deletes a storage entry."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"text":"key","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"key","content":[{"inlineContent":[{"type":"text","text":"The key to delete from the store."}],"type":"paragraph"}]}]},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"If the entry was deleted.","type":"text"}]}],"kind":"content"}],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"roleHeading":"Instance Method","title":"deleteEntry(forKey:)","modules":[{"name":"Auth0"}],"symbolKind":"method","externalID":"s:5Auth018CredentialsStorageP11deleteEntry6forKeySbSS_tF","required":true},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/deleteEntry(forKey:)":{"url":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)","title":"deleteEntry(forKey:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"required":true,"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","kind":"symbol","abstract":[{"type":"text","text":"Deletes a storage entry."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"url":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Deletes a storage entry."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"]}]},{"parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"text":"The key to delete from the store.","type":"text"}]}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the entry was deleted."}]}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)"},"metadata":{"role":"symbol","required":true,"symbolKind":"method","title":"deleteEntry(forKey:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth018CredentialsStorageP11deleteEntry6forKeySbSS_tF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"kind":"symbol","sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","role":"collection","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","title":"CredentialsStorage"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/deleteEntry(forKey:)":{"kind":"symbol","type":"topic","title":"deleteEntry(forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","abstract":[{"type":"text","text":"Deletes a storage entry."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"required":true,"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsstorage/getentry(forkey:).json b/docs/data/documentation/auth0/credentialsstorage/getentry(forkey:).json index e97d889a..5db7838b 100644 --- a/docs/data/documentation/auth0/credentialsstorage/getentry(forkey:).json +++ b/docs/data/documentation/auth0/credentialsstorage/getentry(forkey:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"kind":"text","text":"("},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to get from the store."}]}]}],"kind":"parameters"},{"content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The stored data."}]}],"kind":"content"}],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"role":"symbol","symbolKind":"method","required":true,"title":"getEntry(forKey:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsStorageP8getEntry6forKey10Foundation4DataVSgSS_tF","roleHeading":"Instance Method"},"variants":[{"paths":["\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"url":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/getEntry(forKey:)":{"kind":"symbol","url":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEntry"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"Retrieves a storage entry."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","type":"topic","role":"symbol","required":true,"title":"getEntry(forKey:)"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The key to get from the store."}],"type":"paragraph"}],"name":"key"}]},{"kind":"content","content":[{"text":"Return Value","anchor":"return-value","level":2,"type":"heading"},{"inlineContent":[{"text":"The stored data.","type":"text"}],"type":"paragraph"}]}],"sections":[],"metadata":{"roleHeading":"Instance Method","title":"getEntry(forKey:)","symbolKind":"method","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"kind":"text","text":"("},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsStorageP8getEntry6forKey10Foundation4DataVSgSS_tF"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/getEntry(forKey:)":{"type":"topic","abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"kind":"symbol","required":true,"title":"getEntry(forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","url":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getEntry"},{"kind":"text","text":"("},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","title":"CredentialsStorage"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsstorage/setentry(_:forkey:).json b/docs/data/documentation/auth0/credentialsstorage/setentry(_:forkey:).json index d740bbfa..174e9cf1 100644 --- a/docs/data/documentation/auth0/credentialsstorage/setentry(_:forkey:).json +++ b/docs/data/documentation/auth0/credentialsstorage/setentry(_:forkey:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Sets a storage entry."}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"externalID":"s:5Auth018CredentialsStorageP8setEntry_6forKeySb10Foundation4DataV_SStF","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"title":"setEntry(_:forKey:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"setEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"text":", ","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","interfaceLanguage":"swift"},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"data","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"forKey"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"key"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The data to be stored.","type":"text"}]}],"name":"data"},{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to store it to."}]}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"If the data was stored.","type":"text"}]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"url":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/setEntry(_:forKey:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"setEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Sets a storage entry."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","title":"setEntry(_:forKey:)","required":true,"role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)"}}} \ No newline at end of file +{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","interfaceLanguage":"swift"},"sections":[],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"text":"(","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":", ","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"externalID":"s:5Auth018CredentialsStorageP8setEntry_6forKeySb10Foundation4DataV_SStF","title":"setEntry(_:forKey:)","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Method","required":true,"symbolKind":"method"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"setEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"data","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":", ","kind":"text"},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":" "},{"text":"key","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"The data to be stored.","type":"text"}],"type":"paragraph"}],"name":"data"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to store it to."}]}],"name":"key"}]},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the data was stored."}]}],"kind":"content"}],"abstract":[{"type":"text","text":"Sets a storage entry."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","title":"CredentialsStorage"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/setEntry(_:forKey:)":{"url":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"setEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"setEntry(_:forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","kind":"symbol","role":"symbol","required":true,"type":"topic","abstract":[{"text":"Sets a storage entry.","type":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/databaseuser.json b/docs/data/documentation/auth0/databaseuser.json index 6299e7a6..24405c57 100644 --- a/docs/data/documentation/auth0/databaseuser.json +++ b/docs/data/documentation/auth0/databaseuser.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth012DatabaseUsera","navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"DatabaseUser"}],"role":"symbol","title":"DatabaseUser","symbolKind":"typealias","roleHeading":"Type Alias"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"DatabaseUser"},{"kind":"text","text":" = (email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", username","kind":"text"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, verified","kind":"text"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":")","kind":"text"}],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"variants":[{"paths":["\/documentation\/auth0\/databaseuser"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"DatabaseUser","kind":"identifier"}],"navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"url":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","role":"symbol","type":"topic"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"title":"DatabaseUser","modules":[{"name":"Auth0"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"DatabaseUser"}],"externalID":"s:5Auth012DatabaseUsera","roleHeading":"Type Alias","symbolKind":"typealias","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}]},"variants":[{"paths":["\/documentation\/auth0\/databaseuser"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"DatabaseUser"},{"kind":"text","text":" = (email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", username","kind":"text"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, verified"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":")"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"url":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/defaultscope.json b/docs/data/documentation/auth0/defaultscope.json index 6d3d1a90..734cfe7b 100644 --- a/docs/data/documentation/auth0/defaultscope.json +++ b/docs/data/documentation/auth0/defaultscope.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"defaultScope","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Default scope value used across Auth0.swift. Equals to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"text":".","type":"text"}],"metadata":{"externalID":"s:5Auth012defaultScopeSSvp","symbolKind":"var","modules":[{"name":"Auth0"}],"title":"defaultScope","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"defaultScope","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"roleHeading":"Global Variable","role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/defaultscope"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/defaultScope":{"abstract":[{"text":"Default scope value used across Auth0.swift. Equals to ","type":"text"},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"defaultScope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/defaultscope","title":"defaultScope","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"defaultScope","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Default scope value used across Auth0.swift. Equals to "},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/defaultscope"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"externalID":"s:5Auth012defaultScopeSSvp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"defaultScope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"modules":[{"name":"Auth0"}],"symbolKind":"var","title":"defaultScope","roleHeading":"Global Variable","role":"symbol"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/defaultScope":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"defaultScope"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"abstract":[{"text":"Default scope value used across Auth0.swift. Equals to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"kind":"symbol","url":"\/documentation\/auth0\/defaultscope","title":"defaultScope","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/foundation.json b/docs/data/documentation/auth0/foundation.json index d4f137a5..869c9d8a 100644 --- a/docs/data/documentation/auth0/foundation.json +++ b/docs/data/documentation/auth0/foundation.json @@ -1 +1 @@ -{"sections":[],"metadata":{"externalID":"s:m:s:e:s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF","symbolKind":"extension","title":"Foundation","roleHeading":"Extended Module","role":"collection","modules":[{"name":"Auth0"}]},"topicSections":[{"title":"Extended Structures","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/foundation"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"role":"collection","abstract":[],"url":"\/documentation\/auth0\/foundation","kind":"symbol","title":"Foundation","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"role":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"url":"\/documentation\/auth0\/foundation\/data","navigatorTitle":[{"text":"Data","kind":"identifier"}],"kind":"symbol","title":"Data","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","type":"topic"}}} \ No newline at end of file +{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/foundation"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"],"title":"Extended Structures"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation"},"metadata":{"title":"Foundation","modules":[{"name":"Auth0"}],"roleHeading":"Extended Module","externalID":"s:m:s:e:s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF","role":"collection","symbolKind":"extension"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"url":"\/documentation\/auth0\/foundation","title":"Foundation","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","abstract":[],"role":"collection","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"title":"Data","kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Data","kind":"identifier","preciseIdentifier":"s:10Foundation4DataV"}],"navigatorTitle":[{"text":"Data","kind":"identifier"}],"abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","url":"\/documentation\/auth0\/foundation\/data","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/foundation/data.json b/docs/data/documentation/auth0/foundation/data.json index 7043f0e8..b3dbfb0c 100644 --- a/docs/data/documentation/auth0/foundation/data.json +++ b/docs/data/documentation/auth0/foundation/data.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/foundation\/data"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"}]}]}],"metadata":{"externalID":"s:e:s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF","title":"Data","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"symbolKind":"extension","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"extendedModule":"Foundation","roleHeading":"Extended Structure","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Data"}]},"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","interfaceLanguage":"swift"},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"role":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"url":"\/documentation\/auth0\/foundation\/data","navigatorTitle":[{"text":"Data","kind":"identifier"}],"kind":"symbol","title":"Data","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"role":"collection","abstract":[],"url":"\/documentation\/auth0\/foundation","kind":"symbol","title":"Foundation","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data/a0_encodeBase64URLSafe()":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"a0_encodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Encodes data to base64url."}],"url":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","kind":"symbol","title":"a0_encodeBase64URLSafe()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()","type":"topic"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/foundation\/data"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"}],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"},"metadata":{"title":"Data","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"symbolKind":"extension","extendedModule":"Foundation","role":"symbol","externalID":"s:e:s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF","roleHeading":"Extended Structure","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"navigatorTitle":[{"text":"Data","kind":"identifier"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()"],"title":"Instance Methods"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"url":"\/documentation\/auth0\/foundation","title":"Foundation","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","abstract":[],"role":"collection","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"title":"Data","kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Data","kind":"identifier","preciseIdentifier":"s:10Foundation4DataV"}],"navigatorTitle":[{"text":"Data","kind":"identifier"}],"abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","url":"\/documentation\/auth0\/foundation\/data","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data/a0_encodeBase64URLSafe()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()","title":"a0_encodeBase64URLSafe()","type":"topic","abstract":[{"type":"text","text":"Encodes data to base64url."}],"url":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"a0_encodeBase64URLSafe","kind":"identifier"},{"kind":"text","text":"() -> "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/foundation/data/a0_encodebase64urlsafe().json b/docs/data/documentation/auth0/foundation/data/a0_encodebase64urlsafe().json index 9148b510..d20f2391 100644 --- a/docs/data/documentation/auth0/foundation/data/a0_encodebase64urlsafe().json +++ b/docs/data/documentation/auth0/foundation/data/a0_encodebase64urlsafe().json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Encodes data to base64url."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"a0_encodeBase64URLSafe"},{"text":"() -> ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"title":"a0_encodeBase64URLSafe()","roleHeading":"Instance Method","extendedModule":"Foundation","role":"symbol","externalID":"s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"a0_encodeBase64URLSafe","kind":"identifier"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data/a0_encodeBase64URLSafe()":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"a0_encodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Encodes data to base64url."}],"url":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","kind":"symbol","title":"a0_encodeBase64URLSafe()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"role":"collection","abstract":[],"url":"\/documentation\/auth0\/foundation","kind":"symbol","title":"Foundation","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"role":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"url":"\/documentation\/auth0\/foundation\/data","navigatorTitle":[{"text":"Data","kind":"identifier"}],"kind":"symbol","title":"Data","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","type":"topic"}}} \ No newline at end of file +{"metadata":{"roleHeading":"Instance Method","role":"symbol","symbolKind":"method","extendedModule":"Foundation","externalID":"s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_encodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"title":"a0_encodeBase64URLSafe()"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()"]}],"abstract":[{"type":"text","text":"Encodes data to base64url."}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"a0_encodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data/a0_encodeBase64URLSafe()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()","title":"a0_encodeBase64URLSafe()","type":"topic","abstract":[{"type":"text","text":"Encodes data to base64url."}],"url":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"a0_encodeBase64URLSafe","kind":"identifier"},{"kind":"text","text":"() -> "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"url":"\/documentation\/auth0\/foundation","title":"Foundation","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","abstract":[],"role":"collection","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"title":"Data","kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Data","kind":"identifier","preciseIdentifier":"s:10Foundation4DataV"}],"navigatorTitle":[{"text":"Data","kind":"identifier"}],"abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","url":"\/documentation\/auth0\/foundation\/data","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwk.json b/docs/data/documentation/auth0/jwk.json index 272136ec..f29c835d 100644 --- a/docs/data/documentation/auth0/jwk.json +++ b/docs/data/documentation/auth0/jwk.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"JWK","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"],"title":"Related Documentation"}],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"type":"conformsTo","kind":"relationships"}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk"]}],"metadata":{"externalID":"s:5Auth03JWKV","role":"symbol","title":"JWK","roleHeading":"Structure","modules":[{"name":"Auth0"}],"symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage"],"title":"Instance Properties"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/certUrl":{"title":"certUrl","kind":"symbol","url":"\/documentation\/auth0\/jwk\/certurl","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certUrl","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The URL of the x.509 certificate."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/SE":{"title":"Swift.Encodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SE"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyId":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The unique identifier of the key."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","title":"keyId","role":"symbol","url":"\/documentation\/auth0\/jwk\/keyid"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certThumbprint":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certThumbprint"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","abstract":[{"type":"text","text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","title":"certThumbprint","role":"symbol","url":"\/documentation\/auth0\/jwk\/certthumbprint"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/init(from:)":{"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)","title":"init(from:)","role":"symbol","url":"\/documentation\/auth0\/jwk\/init(from:)"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/modulus":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"modulus"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","abstract":[{"text":"The modulus of the key.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","title":"modulus","role":"symbol","url":"\/documentation\/auth0\/jwk\/modulus"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/algorithm":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"algorithm"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","abstract":[{"text":"The algorithm of the key.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","title":"algorithm","role":"symbol","url":"\/documentation\/auth0\/jwk\/algorithm"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyType":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","abstract":[{"text":"The type of key.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","title":"keyType","role":"symbol","url":"\/documentation\/auth0\/jwk\/keytype"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certChain":{"title":"certChain","url":"\/documentation\/auth0\/jwk\/certchain","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","abstract":[{"type":"text","text":"The x.509 certificate chain."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certChain","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?"}],"role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/usage":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"text":"How the key is meant to be used.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","title":"usage","role":"symbol","url":"\/documentation\/auth0\/jwk\/usage"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/exponent":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","abstract":[{"text":"The exponent of the key.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","title":"exponent","role":"symbol","url":"\/documentation\/auth0\/jwk\/exponent"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk"]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)"],"title":"Initializers"},{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage"]}],"sections":[],"kind":"symbol","metadata":{"externalID":"s:5Auth03JWKV","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Structure","symbolKind":"struct","title":"JWK"},"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"},"abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWK"}],"platforms":["iOS"]}],"kind":"declarations"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/SE":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SE","title":"Swift.Encodable"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certThumbprint":{"url":"\/documentation\/auth0\/jwk\/certthumbprint","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certThumbprint"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[{"text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint).","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","title":"certThumbprint","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/modulus":{"title":"modulus","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"modulus"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/jwk\/modulus","abstract":[{"text":"The modulus of the key.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/algorithm":{"type":"topic","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"algorithm","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","url":"\/documentation\/auth0\/jwk\/algorithm","title":"algorithm","kind":"symbol","role":"symbol","abstract":[{"text":"The algorithm of the key.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/usage":{"url":"\/documentation\/auth0\/jwk\/usage","abstract":[{"type":"text","text":"How the key is meant to be used."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"kind":"symbol","title":"usage","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyType":{"abstract":[{"text":"The type of key.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"keyType","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/jwk\/keytype","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","kind":"symbol","title":"keyType"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/exponent":{"type":"topic","role":"symbol","abstract":[{"type":"text","text":"The exponent of the key."}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","kind":"symbol","url":"\/documentation\/auth0\/jwk\/exponent","title":"exponent"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyId":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","url":"\/documentation\/auth0\/jwk\/keyid","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"keyId","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"keyId","abstract":[{"type":"text","text":"The unique identifier of the key."}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certUrl":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"certUrl","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","abstract":[{"text":"The URL of the x.509 certificate.","type":"text"}],"title":"certUrl","type":"topic","role":"symbol","url":"\/documentation\/auth0\/jwk\/certurl","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certChain":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certChain"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"]?","kind":"text"}],"url":"\/documentation\/auth0\/jwk\/certchain","role":"symbol","abstract":[{"type":"text","text":"The x.509 certificate chain."}],"kind":"symbol","title":"certChain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/init(from:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)","abstract":[],"type":"topic","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"role":"symbol","url":"\/documentation\/auth0\/jwk\/init(from:)"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwk/algorithm.json b/docs/data/documentation/auth0/jwk/algorithm.json index 88e8bdaa..9d41a1cc 100644 --- a/docs/data/documentation/auth0/jwk/algorithm.json +++ b/docs/data/documentation/auth0/jwk/algorithm.json @@ -1 +1 @@ -{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/algorithm"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","abstract":[{"type":"text","text":"The algorithm of the key."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"algorithm","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth03JWKV9algorithmSSSgvp","symbolKind":"property","title":"algorithm","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"algorithm"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/algorithm":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"algorithm"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","abstract":[{"text":"The algorithm of the key.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","title":"algorithm","role":"symbol","url":"\/documentation\/auth0\/jwk\/algorithm"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/jwk\/algorithm"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"The algorithm of the key."}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"algorithm"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm"},"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"algorithm","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"symbolKind":"property","title":"algorithm","role":"symbol","externalID":"s:5Auth03JWKV9algorithmSSSgvp"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/algorithm":{"type":"topic","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"algorithm","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","url":"\/documentation\/auth0\/jwk\/algorithm","title":"algorithm","kind":"symbol","role":"symbol","abstract":[{"text":"The algorithm of the key.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwk/certchain.json b/docs/data/documentation/auth0/jwk/certchain.json index 97411585..68e09d38 100644 --- a/docs/data/documentation/auth0/jwk/certchain.json +++ b/docs/data/documentation/auth0/jwk/certchain.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/certchain"]}],"kind":"symbol","abstract":[{"text":"The x.509 certificate chain.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"sections":[],"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"certChain"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]?","kind":"text"}],"roleHeading":"Instance Property","externalID":"s:5Auth03JWKV9certChainSaySSGSgvp","role":"symbol","title":"certChain"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"certChain","kind":"identifier"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]?"}]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/certChain":{"title":"certChain","url":"\/documentation\/auth0\/jwk\/certchain","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","abstract":[{"type":"text","text":"The x.509 certificate chain."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certChain","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?"}],"role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","interfaceLanguage":"swift"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/certchain"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","abstract":[{"text":"The x.509 certificate chain.","type":"text"}],"metadata":{"externalID":"s:5Auth03JWKV9certChainSaySSGSgvp","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"title":"certChain","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certChain","kind":"identifier"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]?","kind":"text"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certChain"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]?","kind":"text"}],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certChain":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certChain"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"]?","kind":"text"}],"url":"\/documentation\/auth0\/jwk\/certchain","role":"symbol","abstract":[{"type":"text","text":"The x.509 certificate chain."}],"kind":"symbol","title":"certChain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwk/certthumbprint.json b/docs/data/documentation/auth0/jwk/certthumbprint.json index 005f749c..72d5dcfb 100644 --- a/docs/data/documentation/auth0/jwk/certthumbprint.json +++ b/docs/data/documentation/auth0/jwk/certthumbprint.json @@ -1 +1 @@ -{"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certThumbprint"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"certThumbprint","symbolKind":"property","externalID":"s:5Auth03JWKV14certThumbprintSSSgvp"},"variants":[{"paths":["\/documentation\/auth0\/jwk\/certthumbprint"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint"},"sections":[],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"abstract":[{"type":"text","text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint)."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"certThumbprint"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/certThumbprint":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certThumbprint"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","abstract":[{"type":"text","text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint)."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","title":"certThumbprint","role":"symbol","url":"\/documentation\/auth0\/jwk\/certthumbprint"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint)."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certThumbprint","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"certThumbprint","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"externalID":"s:5Auth03JWKV14certThumbprintSSSgvp","symbolKind":"property","title":"certThumbprint","role":"symbol","roleHeading":"Instance Property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/certthumbprint"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certThumbprint":{"url":"\/documentation\/auth0\/jwk\/certthumbprint","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certThumbprint"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[{"text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint).","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","title":"certThumbprint","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwk/certurl.json b/docs/data/documentation/auth0/jwk/certurl.json index c94b39ac..e82d2ea5 100644 --- a/docs/data/documentation/auth0/jwk/certurl.json +++ b/docs/data/documentation/auth0/jwk/certurl.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certUrl"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"languages":["swift"]}]}],"metadata":{"roleHeading":"Instance Property","role":"symbol","symbolKind":"property","title":"certUrl","externalID":"s:5Auth03JWKV7certUrlSSSgvp","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"certUrl","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}]},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/certurl"]}],"abstract":[{"type":"text","text":"The URL of the x.509 certificate."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certUrl":{"title":"certUrl","kind":"symbol","url":"\/documentation\/auth0\/jwk\/certurl","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certUrl","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The URL of the x.509 certificate."}],"type":"topic"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"certUrl"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/certurl"]}],"kind":"symbol","sections":[],"abstract":[{"type":"text","text":"The URL of the x.509 certificate."}],"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"certUrl","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:5Auth03JWKV7certUrlSSSgvp","title":"certUrl","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certUrl":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"certUrl","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","abstract":[{"text":"The URL of the x.509 certificate.","type":"text"}],"title":"certUrl","type":"topic","role":"symbol","url":"\/documentation\/auth0\/jwk\/certurl","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwk/exponent.json b/docs/data/documentation/auth0/jwk/exponent.json index 192db34a..9ae027f5 100644 --- a/docs/data/documentation/auth0/jwk/exponent.json +++ b/docs/data/documentation/auth0/jwk/exponent.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"exponent","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"exponent","externalID":"s:5Auth03JWKV8exponentSSSgvp","role":"symbol","roleHeading":"Instance Property"},"abstract":[{"type":"text","text":"The exponent of the key."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/exponent"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/exponent":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","abstract":[{"text":"The exponent of the key.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","title":"exponent","role":"symbol","url":"\/documentation\/auth0\/jwk\/exponent"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"}}} \ No newline at end of file +{"metadata":{"role":"symbol","symbolKind":"property","roleHeading":"Instance Property","title":"exponent","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"exponent","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"externalID":"s:5Auth03JWKV8exponentSSSgvp","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"exponent"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/jwk\/exponent"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent"},"sections":[],"abstract":[{"text":"The exponent of the key.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/exponent":{"type":"topic","role":"symbol","abstract":[{"type":"text","text":"The exponent of the key."}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","kind":"symbol","url":"\/documentation\/auth0\/jwk\/exponent","title":"exponent"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwk/init(from:).json b/docs/data/documentation/auth0/jwk/init(from:).json index 2bb28fae..9860b8b9 100644 --- a/docs/data/documentation/auth0/jwk/init(from:).json +++ b/docs/data/documentation/auth0/jwk/init(from:).json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/jwk\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"kind":"text","text":" "},{"text":"decoder","kind":"internalParam"},{"kind":"text","text":": any "},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"role":"symbol","title":"init(from:)","symbolKind":"init","modules":[{"name":"Auth0"}],"roleHeading":"Initializer","externalID":"s:5Auth03JWKV4fromACs7Decoder_p_tKcfc","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/init(from:)":{"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)","title":"init(from:)","role":"symbol","url":"\/documentation\/auth0\/jwk\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"sections":[],"metadata":{"roleHeading":"Initializer","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"role":"symbol","externalID":"s:5Auth03JWKV4fromACs7Decoder_p_tKcfc","symbolKind":"init","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/jwk\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Decodable.init(from:)"},{"text":".","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/init(from:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)","abstract":[],"type":"topic","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"role":"symbol","url":"\/documentation\/auth0\/jwk\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwk/keyid.json b/docs/data/documentation/auth0/jwk/keyid.json index 2d57ced1..fe744ce0 100644 --- a/docs/data/documentation/auth0/jwk/keyid.json +++ b/docs/data/documentation/auth0/jwk/keyid.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"keyId","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"languages":["swift"]}]}],"sections":[],"abstract":[{"type":"text","text":"The unique identifier of the key."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/keyid"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"keyId","externalID":"s:5Auth03JWKV5keyIdSSSgvp","roleHeading":"Instance Property","symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyId":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"The unique identifier of the key."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","title":"keyId","role":"symbol","url":"\/documentation\/auth0\/jwk\/keyid"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/keyid"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","interfaceLanguage":"swift"},"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"keyId","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"keyId","modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","externalID":"s:5Auth03JWKV5keyIdSSSgvp","roleHeading":"Instance Property"},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"keyId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"abstract":[{"type":"text","text":"The unique identifier of the key."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyId":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","url":"\/documentation\/auth0\/jwk\/keyid","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"keyId","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"keyId","abstract":[{"type":"text","text":"The unique identifier of the key."}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwk/keytype.json b/docs/data/documentation/auth0/jwk/keytype.json index 2ee71580..e41769b6 100644 --- a/docs/data/documentation/auth0/jwk/keytype.json +++ b/docs/data/documentation/auth0/jwk/keytype.json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"keyType","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"keyType","role":"symbol","externalID":"s:5Auth03JWKV7keyTypeSSvp"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType"},"abstract":[{"type":"text","text":"The type of key."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"keyType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"variants":[{"paths":["\/documentation\/auth0\/jwk\/keytype"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyType":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","abstract":[{"text":"The type of key.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","title":"keyType","role":"symbol","url":"\/documentation\/auth0\/jwk\/keytype"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth03JWKV7keyTypeSSvp","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyType"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","symbolKind":"property","title":"keyType"},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The type of key."}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"variants":[{"paths":["\/documentation\/auth0\/jwk\/keytype"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keyType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyType":{"abstract":[{"text":"The type of key.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"keyType","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/jwk\/keytype","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","kind":"symbol","title":"keyType"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwk/modulus.json b/docs/data/documentation/auth0/jwk/modulus.json index 8eaffd04..379d32dc 100644 --- a/docs/data/documentation/auth0/jwk/modulus.json +++ b/docs/data/documentation/auth0/jwk/modulus.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus"},"variants":[{"paths":["\/documentation\/auth0\/jwk\/modulus"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"modulus","externalID":"s:5Auth03JWKV7modulusSSSgvp","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"modulus"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"modulus"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"kind":"symbol","abstract":[{"type":"text","text":"The modulus of the key."}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/modulus":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"modulus"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","abstract":[{"text":"The modulus of the key.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","title":"modulus","role":"symbol","url":"\/documentation\/auth0\/jwk\/modulus"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:5Auth03JWKV7modulusSSSgvp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"modulus"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"title":"modulus"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/modulus"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"The modulus of the key."}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"modulus","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/modulus":{"title":"modulus","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"modulus"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/jwk\/modulus","abstract":[{"text":"The modulus of the key.","type":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwk/usage.json b/docs/data/documentation/auth0/jwk/usage.json index 08f50c9a..225c0a38 100644 --- a/docs/data/documentation/auth0/jwk/usage.json +++ b/docs/data/documentation/auth0/jwk/usage.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/usage"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage"},"kind":"symbol","metadata":{"externalID":"s:5Auth03JWKV5usageSSSgvp","roleHeading":"Instance Property","title":"usage","symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"abstract":[{"text":"How the key is meant to be used.","type":"text"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/usage":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"text":"How the key is meant to be used.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","title":"usage","role":"symbol","url":"\/documentation\/auth0\/jwk\/usage"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/usage"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"sections":[],"metadata":{"symbolKind":"property","title":"usage","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth03JWKV5usageSSSgvp"},"abstract":[{"type":"text","text":"How the key is meant to be used."}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/usage":{"url":"\/documentation\/auth0\/jwk\/usage","abstract":[{"type":"text","text":"How the key is meant to be used."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"kind":"symbol","title":"usage","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwks.json b/docs/data/documentation/auth0/jwks.json index bfc8f3f3..bce9e282 100644 --- a/docs/data/documentation/auth0/jwks.json +++ b/docs/data/documentation/auth0/jwks.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"externalID":"s:5Auth04JWKSV","symbolKind":"struct","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWKS"}],"modules":[{"name":"Auth0"}],"roleHeading":"Structure","title":"JWKS"},"abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"},"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"kind":"relationships"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"]}],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)"]},{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)"],"title":"Instance Methods"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-key-sets":{"type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets","titleInlineContent":[{"type":"text","text":"JSON Web Key Sets"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets","title":"JSON Web Key Sets"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/init(from:)":{"url":"\/documentation\/auth0\/jwks\/init(from:)","role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","type":"topic","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"title":"init(from:)","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/keys":{"type":"topic","url":"\/documentation\/auth0\/jwks\/keys","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"keys"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"kind":"text","text":"]"}],"role":"symbol","abstract":[{"text":"The keys in the key set.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys","title":"keys","kind":"symbol"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/SE":{"identifier":"doc:\/\/com.auth0.Auth0\/SE","title":"Swift.Encodable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/key(id:)":{"type":"topic","url":"\/documentation\/auth0\/jwks\/key(id:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"key"},{"kind":"text","text":"("},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"kind":"text","text":"?"}],"role":"symbol","abstract":[{"text":"Gets a key from the key set by its identifier (","type":"text"},{"type":"codeVoice","code":"kid"},{"type":"text","text":")."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)","title":"key(id:)","kind":"symbol"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWKS"}]}]}],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)"]},{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys"]},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"]}],"variants":[{"paths":["\/documentation\/auth0\/jwks"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Structure","externalID":"s:5Auth04JWKSV","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWKS"}],"symbolKind":"struct","role":"symbol","title":"JWKS"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable","title":"Swift.Decodable"},"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-key-sets":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets","title":"JSON Web Key Sets","titleInlineContent":[{"text":"JSON Web Key Sets","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/key(id:)":{"title":"key(id:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"key","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"JWK","preciseIdentifier":"s:5Auth03JWKV","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/jwks\/key(id:)","abstract":[{"type":"text","text":"Gets a key from the key set by its identifier ("},{"type":"codeVoice","code":"kid"},{"type":"text","text":")."}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/init(from:)":{"abstract":[],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"type":"topic","url":"\/documentation\/auth0\/jwks\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","role":"symbol","kind":"symbol","title":"init(from:)"},"doc://com.auth0.Auth0/SE":{"title":"Swift.Encodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SE"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/keys":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"keys","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"JWK","preciseIdentifier":"s:5Auth03JWKV"},{"text":"]","kind":"text"}],"url":"\/documentation\/auth0\/jwks\/keys","title":"keys","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys","abstract":[{"text":"The keys in the key set.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwks/init(from:).json b/docs/data/documentation/auth0/jwks/init(from:).json index f01c0eb3..35c11c86 100644 --- a/docs/data/documentation/auth0/jwks/init(from:).json +++ b/docs/data/documentation/auth0/jwks/init(from:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks\/init(from:)"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"abstract":[{"type":"text","text":"Inherited from "},{"code":"Decodable.init(from:)","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"kind":"text","text":": any "},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)"},"kind":"symbol","metadata":{"roleHeading":"Initializer","externalID":"s:5Auth04JWKSV4fromACs7Decoder_p_tKcfc","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"modules":[{"name":"Auth0"}],"title":"init(from:)","symbolKind":"init","role":"symbol"},"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/init(from:)":{"url":"\/documentation\/auth0\/jwks\/init(from:)","role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","type":"topic","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"title":"init(from:)","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Inherited from "},{"code":"Decodable.init(from:)","type":"codeVoice"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/jwks\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth04JWKSV4fromACs7Decoder_p_tKcfc","symbolKind":"init","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"roleHeading":"Initializer","title":"init(from:)","modules":[{"name":"Auth0"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/init(from:)":{"abstract":[],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"type":"topic","url":"\/documentation\/auth0\/jwks\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","role":"symbol","kind":"symbol","title":"init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwks/key(id:).json b/docs/data/documentation/auth0/jwks/key(id:).json index c5fce388..7149d3a1 100644 --- a/docs/data/documentation/auth0/jwks/key(id:).json +++ b/docs/data/documentation/auth0/jwks/key(id:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks\/key(id:)"]}],"abstract":[{"type":"text","text":"Gets a key from the key set by its identifier ("},{"code":"kid","type":"codeVoice"},{"text":").","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"key","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"id"},{"kind":"text","text":" "},{"text":"kid","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth03JWKV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","text":"JWK"},{"text":"?","kind":"text"}],"languages":["swift"]}]}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"metadata":{"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"key"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"JWK","preciseIdentifier":"s:5Auth03JWKV","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"symbolKind":"method","role":"symbol","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"title":"key(id:)","externalID":"s:5Auth04JWKSV3key2idAA3JWKVSgSS_tF"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/key(id:)":{"type":"topic","url":"\/documentation\/auth0\/jwks\/key(id:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"key"},{"kind":"text","text":"("},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"kind":"text","text":"?"}],"role":"symbol","abstract":[{"text":"Gets a key from the key set by its identifier (","type":"text"},{"type":"codeVoice","code":"kid"},{"type":"text","text":")."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)","title":"key(id:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"variants":[{"paths":["\/documentation\/auth0\/jwks\/key(id:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"title":"key(id:)","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"key","kind":"identifier"},{"kind":"text","text":"("},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth03JWKV","text":"JWK","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"extendedModule":"Auth0","modules":[{"name":"Auth0"}],"externalID":"s:5Auth04JWKSV3key2idAA3JWKVSgSS_tF","role":"symbol"},"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"Gets a key from the key set by its identifier ("},{"type":"codeVoice","code":"kid"},{"text":").","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"key"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"text":" ","kind":"text"},{"text":"kid","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","preciseIdentifier":"s:5Auth03JWKV","kind":"typeIdentifier","text":"JWK"},{"kind":"text","text":"?"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/key(id:)":{"title":"key(id:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"key","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"JWK","preciseIdentifier":"s:5Auth03JWKV","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/jwks\/key(id:)","abstract":[{"type":"text","text":"Gets a key from the key set by its identifier ("},{"type":"codeVoice","code":"kid"},{"type":"text","text":")."}],"role":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwks/keys.json b/docs/data/documentation/auth0/jwks/keys.json index ab10dd34..55e0193c 100644 --- a/docs/data/documentation/auth0/jwks/keys.json +++ b/docs/data/documentation/auth0/jwks/keys.json @@ -1 +1 @@ -{"metadata":{"roleHeading":"Instance Property","externalID":"s:5Auth04JWKSV4keysSayAA3JWKVGvp","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"keys","kind":"identifier"},{"kind":"text","text":": ["},{"text":"JWK","kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV"},{"text":"]","kind":"text"}],"title":"keys","modules":[{"name":"Auth0"}],"role":"symbol"},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"abstract":[{"text":"The keys in the key set.","type":"text"}],"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"keys","kind":"identifier"},{"kind":"text","text":": ["},{"text":"JWK","preciseIdentifier":"s:5Auth03JWKV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"},{"kind":"text","text":"]"}]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/jwks\/keys"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"kind":"symbol","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"url":"\/documentation\/auth0\/jwk","navigatorTitle":[{"kind":"identifier","text":"JWK"}],"title":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/keys":{"type":"topic","url":"\/documentation\/auth0\/jwks\/keys","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"keys"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"kind":"text","text":"]"}],"role":"symbol","abstract":[{"text":"The keys in the key set.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys","title":"keys","kind":"symbol"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks\/keys"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"keys"},{"text":": [","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"typeIdentifier","text":"JWK","preciseIdentifier":"s:5Auth03JWKV"},{"kind":"text","text":"]"}]}],"kind":"declarations"}],"abstract":[{"text":"The keys in the key set.","type":"text"}],"sections":[],"kind":"symbol","metadata":{"title":"keys","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"keys","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:5Auth03JWKV","kind":"typeIdentifier","text":"JWK"},{"text":"]","kind":"text"}],"symbolKind":"property","role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth04JWKSV4keysSayAA3JWKVGvp","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/keys":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"keys","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"JWK","preciseIdentifier":"s:5Auth03JWKV"},{"text":"]","kind":"text"}],"url":"\/documentation\/auth0\/jwks\/keys","title":"keys","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys","abstract":[{"text":"The keys in the key set.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"JWKS","kind":"identifier"}],"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"url":"\/documentation\/auth0\/jwks","title":"JWKS","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"navigatorTitle":[{"text":"JWK","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","title":"JWK"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/loggable.json b/docs/data/documentation/auth0/loggable.json index 36b9c0c1..690e1ea2 100644 --- a/docs/data/documentation/auth0/loggable.json +++ b/docs/data/documentation/auth0/loggable.json @@ -1 +1 @@ -{"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)"],"title":"Instance Methods"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"metadata":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}],"role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth08LoggableP","symbolKind":"protocol","title":"Loggable","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"roleHeading":"Protocol"},"kind":"symbol","relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"],"kind":"relationships","type":"inheritedBy","title":"Inherited By"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Loggable","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/loggable"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"url":"\/documentation\/auth0\/loggable","title":"Loggable","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logger":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","type":"topic","abstract":[{"text":"Logger used to print log statements.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logger","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth06LoggerP","text":"Logger","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/loggable\/logger","title":"logger","required":true,"role":"symbol","kind":"symbol"},"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"text":"Management API v2","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logging(enabled:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"logging"},{"kind":"text","text":"("},{"text":"enabled","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/loggable\/logging(enabled:)","role":"symbol","abstract":[{"text":"Turn on\/off Auth0.swift debug logging of HTTP requests and responses.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)","kind":"symbol","type":"topic","title":"logging(enabled:)"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/using(logger:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)","type":"topic","abstract":[{"type":"text","text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"text":"logger","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP","text":"Logger"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/loggable\/using(logger:)","title":"using(logger:)","role":"symbol","kind":"symbol"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"roleHeading":"Protocol","externalID":"s:5Auth08LoggableP","modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Loggable","kind":"identifier"}],"symbolKind":"protocol","role":"symbol","title":"Loggable"},"sections":[],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"],"title":"Inherited By","type":"inheritedBy","kind":"relationships"}],"kind":"symbol","topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger"]},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Loggable"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"kind":"symbol","title":"Loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Loggable","kind":"identifier"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/loggable"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/using(logger:)":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"logger"},{"text":": ","kind":"text"},{"text":"Logger","kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"url":"\/documentation\/auth0\/loggable\/using(logger:)","kind":"symbol","title":"using(logger:)"},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","titleInlineContent":[{"type":"text","text":"Management API v2"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logger":{"required":true,"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"logger","kind":"identifier"},{"kind":"text","text":": "},{"text":"Logger","kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP"},{"text":"?","kind":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","url":"\/documentation\/auth0\/loggable\/logger","title":"logger","abstract":[{"type":"text","text":"Logger used to print log statements."}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logging(enabled:)":{"abstract":[{"type":"text","text":"Turn on\/off Auth0.swift debug logging of HTTP requests and responses."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)","title":"logging(enabled:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"logging","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"enabled"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/loggable\/logging(enabled:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/loggable/logger.json b/docs/data/documentation/auth0/loggable/logger.json index 290be6eb..9eff185f 100644 --- a/docs/data/documentation/auth0/loggable/logger.json +++ b/docs/data/documentation/auth0/loggable/logger.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logger","kind":"identifier"},{"kind":"text","text":": "},{"text":"Logger","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","preciseIdentifier":"s:5Auth06LoggerP","kind":"typeIdentifier"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"set"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger"},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable\/logger"]}],"metadata":{"role":"symbol","externalID":"s:5Auth08LoggableP6loggerAA6Logger_pSgvp","roleHeading":"Instance Property","required":true,"title":"logger","symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logger","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth06LoggerP","text":"Logger","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"sections":[],"abstract":[{"text":"Logger used to print log statements.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"url":"\/documentation\/auth0\/loggable","title":"Loggable","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Logger","kind":"identifier"}],"navigatorTitle":[{"text":"Logger","kind":"identifier"}],"abstract":[{"type":"text","text":"Logger for debugging purposes."}],"url":"\/documentation\/auth0\/logger","title":"Logger","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logger":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","type":"topic","abstract":[{"text":"Logger used to print log statements.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logger","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth06LoggerP","text":"Logger","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/loggable\/logger","title":"logger","required":true,"role":"symbol","kind":"symbol"}}} \ No newline at end of file +{"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/loggable\/logger"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Logger used to print log statements."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"logger","kind":"identifier"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","kind":"typeIdentifier","text":"Logger","preciseIdentifier":"s:5Auth06LoggerP"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"text":"set","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"logger","required":true,"externalID":"s:5Auth08LoggableP6loggerAA6Logger_pSgvp","roleHeading":"Instance Property","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"logger"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth06LoggerP","text":"Logger","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"kind":"symbol","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","type":"topic","title":"Logger","navigatorTitle":[{"kind":"identifier","text":"Logger"}],"url":"\/documentation\/auth0\/logger"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"kind":"symbol","title":"Loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Loggable","kind":"identifier"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/loggable"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logger":{"required":true,"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"logger","kind":"identifier"},{"kind":"text","text":": "},{"text":"Logger","kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP"},{"text":"?","kind":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","url":"\/documentation\/auth0\/loggable\/logger","title":"logger","abstract":[{"type":"text","text":"Logger used to print log statements."}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/loggable/logging(enabled:).json b/docs/data/documentation/auth0/loggable/logging(enabled:).json index cb41cfbc..0a899a49 100644 --- a/docs/data/documentation/auth0/loggable/logging(enabled:).json +++ b/docs/data/documentation/auth0/loggable/logging(enabled:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"logging","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"enabled","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Flag to turn logging on\/off."}]}]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"By default all logging is "},{"type":"strong","inlineContent":[{"type":"text","text":"disabled"}]},{"type":"text","text":"."}]}],"name":"Note"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"For the flag to take effect, logging should be turned on\/off "},{"inlineContent":[{"type":"text","text":"before"}],"type":"strong"},{"type":"text","text":" making requests to Auth0."}],"type":"paragraph"}],"name":"Important","style":"important"}]}],"abstract":[{"type":"text","text":"Turn on\/off Auth0.swift debug logging of HTTP requests and responses."}],"variants":[{"paths":["\/documentation\/auth0\/loggable\/logging(enabled:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth08LoggablePAAE7logging7enabledxSb_tF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"logging"},{"kind":"text","text":"("},{"text":"enabled","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"extendedModule":"Auth0","title":"logging(enabled:)"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"url":"\/documentation\/auth0\/loggable","title":"Loggable","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logging(enabled:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"logging"},{"kind":"text","text":"("},{"text":"enabled","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/loggable\/logging(enabled:)","role":"symbol","abstract":[{"text":"Turn on\/off Auth0.swift debug logging of HTTP requests and responses.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)","kind":"symbol","type":"topic","title":"logging(enabled:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable\/logging(enabled:)"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"logging","kind":"identifier"},{"text":"(","kind":"text"},{"text":"enabled","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Flag to turn logging on\/off."}],"type":"paragraph"}],"name":"enabled"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"type":"aside","style":"note","name":"Note","content":[{"inlineContent":[{"text":"By default all logging is ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"disabled"}]},{"text":".","type":"text"}],"type":"paragraph"}]},{"type":"aside","name":"Important","content":[{"type":"paragraph","inlineContent":[{"text":"For the flag to take effect, logging should be turned on\/off ","type":"text"},{"inlineContent":[{"text":"before","type":"text"}],"type":"strong"},{"type":"text","text":" making requests to Auth0."}]}],"style":"important"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)"},"abstract":[{"text":"Turn on\/off Auth0.swift debug logging of HTTP requests and responses.","type":"text"}],"metadata":{"extendedModule":"Auth0","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"logging","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"title":"logging(enabled:)","externalID":"s:5Auth08LoggablePAAE7logging7enabledxSb_tF","role":"symbol","symbolKind":"method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logging(enabled:)":{"abstract":[{"type":"text","text":"Turn on\/off Auth0.swift debug logging of HTTP requests and responses."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)","title":"logging(enabled:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"logging","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"enabled"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/loggable\/logging(enabled:)"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"kind":"symbol","title":"Loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Loggable","kind":"identifier"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/loggable"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/loggable/using(logger:).json b/docs/data/documentation/auth0/loggable/using(logger:).json index b39dd03a..3c75c5de 100644 --- a/docs/data/documentation/auth0/loggable/using(logger:).json +++ b/docs/data/documentation/auth0/loggable/using(logger:).json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"logger"},{"kind":"text","text":": "},{"text":"Logger","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Logger used to print log statements."}]}],"name":"logger"}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"name":"Note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"By default all logging is ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"disabled"}]},{"type":"text","text":"."}]}],"style":"note"},{"style":"important","content":[{"inlineContent":[{"type":"text","text":"Logging should be turned on\/off "},{"type":"strong","inlineContent":[{"type":"text","text":"before"}]},{"text":" making request to Auth0 for the flag to take effect.","type":"text"}],"type":"paragraph"}],"name":"Important","type":"aside"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"using"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"logger"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP","text":"Logger"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"extendedModule":"Auth0","externalID":"s:5Auth08LoggablePAAE5using6loggerxAA6Logger_p_tF","symbolKind":"method","role":"symbol","title":"using(logger:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable\/using(logger:)"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Logger","kind":"identifier"}],"navigatorTitle":[{"text":"Logger","kind":"identifier"}],"abstract":[{"type":"text","text":"Logger for debugging purposes."}],"url":"\/documentation\/auth0\/logger","title":"Logger","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"url":"\/documentation\/auth0\/loggable","title":"Loggable","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/using(logger:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)","type":"topic","abstract":[{"type":"text","text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"text":"logger","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP","text":"Logger"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/loggable\/using(logger:)","title":"using(logger:)","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","metadata":{"extendedModule":"Auth0","role":"symbol","title":"using(logger:)","roleHeading":"Instance Method","externalID":"s:5Auth08LoggablePAAE5using6loggerxAA6Logger_p_tF","symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"logger"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth06LoggerP","kind":"typeIdentifier","text":"Logger"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]},"abstract":[{"type":"text","text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"using"},{"text":"(","kind":"text"},{"text":"logger","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP","text":"Logger","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}]},{"parameters":[{"name":"logger","content":[{"inlineContent":[{"type":"text","text":"Logger used to print log statements."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"name":"Note","content":[{"type":"paragraph","inlineContent":[{"text":"By default all logging is ","type":"text"},{"inlineContent":[{"type":"text","text":"disabled"}],"type":"strong"},{"type":"text","text":"."}]}],"type":"aside","style":"note"},{"content":[{"inlineContent":[{"type":"text","text":"Logging should be turned on\/off "},{"inlineContent":[{"type":"text","text":"before"}],"type":"strong"},{"type":"text","text":" making request to Auth0 for the flag to take effect."}],"type":"paragraph"}],"name":"Important","type":"aside","style":"important"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable\/using(logger:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"kind":"symbol","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","type":"topic","title":"Logger","navigatorTitle":[{"kind":"identifier","text":"Logger"}],"url":"\/documentation\/auth0\/logger"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/using(logger:)":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"logger"},{"text":": ","kind":"text"},{"text":"Logger","kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"url":"\/documentation\/auth0\/loggable\/using(logger:)","kind":"symbol","title":"using(logger:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"kind":"symbol","title":"Loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Loggable","kind":"identifier"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/loggable"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/logger.json b/docs/data/documentation/auth0/logger.json index 615c75f7..8212c3da 100644 --- a/docs/data/documentation/auth0/logger.json +++ b/docs/data/documentation/auth0/logger.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Logger","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/logger"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"roleHeading":"Protocol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Logger"}],"symbolKind":"protocol","role":"symbol","modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"Logger","kind":"identifier"}],"externalID":"s:5Auth06LoggerP","title":"Logger"},"abstract":[{"type":"text","text":"Logger for debugging purposes."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Logger","kind":"identifier"}],"navigatorTitle":[{"text":"Logger","kind":"identifier"}],"abstract":[{"type":"text","text":"Logger for debugging purposes."}],"url":"\/documentation\/auth0\/logger","title":"Logger","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(response:data:)":{"url":"\/documentation\/auth0\/logger\/trace(response:data:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","title":"trace(response:data:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"text":"response","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLResponse","text":"URLResponse","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"data","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"type":"topic","abstract":[{"type":"text","text":"Log an HTTP response."}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(url:source:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)","kind":"symbol","url":"\/documentation\/auth0\/logger\/trace(url:source:)","title":"trace(url:source:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"kind":"text","text":"("},{"text":"url","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":", "},{"text":"source","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"abstract":[{"text":"Log a URL.","type":"text"}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(request:session:)":{"url":"\/documentation\/auth0\/logger\/trace(request:session:)","type":"topic","required":true,"title":"trace(request:session:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","abstract":[{"type":"text","text":"Log an HTTP request."}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"request"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URLRequest","preciseIdentifier":"s:10Foundation10URLRequestV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":")"}],"kind":"symbol"}}} \ No newline at end of file +{"metadata":{"role":"symbol","title":"Logger","roleHeading":"Protocol","navigatorTitle":[{"text":"Logger","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"symbolKind":"protocol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth06LoggerP"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Logger","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger"]}],"abstract":[{"type":"text","text":"Logger for debugging purposes."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(url:source:)":{"required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"text":"url","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"text":", ","kind":"text"},{"text":"source","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"kind":"symbol","abstract":[{"type":"text","text":"Log a URL."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)","type":"topic","title":"trace(url:source:)","url":"\/documentation\/auth0\/logger\/trace(url:source:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(response:data:)":{"kind":"symbol","title":"trace(response:data:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Log an HTTP response."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"response"},{"kind":"text","text":": "},{"text":"URLResponse","preciseIdentifier":"c:objc(cs)NSURLResponse","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"data","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"url":"\/documentation\/auth0\/logger\/trace(response:data:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(request:session:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"trace","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"request"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation10URLRequestV","kind":"typeIdentifier","text":"URLRequest"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Log an HTTP request."}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/logger\/trace(request:session:)","kind":"symbol","title":"trace(request:session:)"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"kind":"symbol","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","type":"topic","title":"Logger","navigatorTitle":[{"kind":"identifier","text":"Logger"}],"url":"\/documentation\/auth0\/logger"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/logger/trace(request:session:).json b/docs/data/documentation/auth0/logger/trace(request:session:).json index 1c97daa1..b9ad5bfc 100644 --- a/docs/data/documentation/auth0/logger/trace(request:session:).json +++ b/docs/data/documentation/auth0/logger/trace(request:session:).json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"text":"request","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URLRequest","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation10URLRequestV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"kind":"text","text":")"}],"platforms":["iOS"],"languages":["swift"]}]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger\/trace(request:session:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)"},"metadata":{"roleHeading":"Instance Method","title":"trace(request:session:)","externalID":"s:5Auth06LoggerP5trace7request7sessiony10Foundation10URLRequestV_So12NSURLSessionCtF","required":true,"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"text":"request","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation10URLRequestV","text":"URLRequest"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"kind":"text","text":")"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"abstract":[{"type":"text","text":"Log an HTTP request."}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Logger","kind":"identifier"}],"navigatorTitle":[{"text":"Logger","kind":"identifier"}],"abstract":[{"type":"text","text":"Logger for debugging purposes."}],"url":"\/documentation\/auth0\/logger","title":"Logger","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(request:session:)":{"url":"\/documentation\/auth0\/logger\/trace(request:session:)","type":"topic","required":true,"title":"trace(request:session:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","abstract":[{"type":"text","text":"Log an HTTP request."}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"request"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URLRequest","preciseIdentifier":"s:10Foundation10URLRequestV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":")"}],"kind":"symbol"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","sections":[],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","title":"trace(request:session:)","externalID":"s:5Auth06LoggerP5trace7request7sessiony10Foundation10URLRequestV_So12NSURLSessionCtF","symbolKind":"method","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"request"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation10URLRequestV","text":"URLRequest"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":")"}],"required":true},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"request"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation10URLRequestV","text":"URLRequest","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":")","kind":"text"}],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"Log an HTTP request."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger\/trace(request:session:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(request:session:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"trace","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"request"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation10URLRequestV","kind":"typeIdentifier","text":"URLRequest"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Log an HTTP request."}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/logger\/trace(request:session:)","kind":"symbol","title":"trace(request:session:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"kind":"symbol","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","type":"topic","title":"Logger","navigatorTitle":[{"kind":"identifier","text":"Logger"}],"url":"\/documentation\/auth0\/logger"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/logger/trace(response:data:).json b/docs/data/documentation/auth0/logger/trace(response:data:).json index e4215690..ca62ad37 100644 --- a/docs/data/documentation/auth0/logger/trace(response:data:).json +++ b/docs/data/documentation/auth0/logger/trace(response:data:).json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/logger\/trace(response:data:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Log an HTTP response."}],"metadata":{"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"title":"trace(response:data:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"response"},{"text":": ","kind":"text"},{"text":"URLResponse","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLResponse"},{"kind":"text","text":", "},{"text":"data","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"text":"?)","kind":"text"}],"role":"symbol","externalID":"s:5Auth06LoggerP5trace8response4dataySo13NSURLResponseC_10Foundation4DataVSgtF","required":true,"symbolKind":"method"},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)"},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"response"},{"text":": ","kind":"text"},{"text":"URLResponse","preciseIdentifier":"c:objc(cs)NSURLResponse","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?)"}]}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Logger","kind":"identifier"}],"navigatorTitle":[{"text":"Logger","kind":"identifier"}],"abstract":[{"type":"text","text":"Logger for debugging purposes."}],"url":"\/documentation\/auth0\/logger","title":"Logger","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(response:data:)":{"url":"\/documentation\/auth0\/logger\/trace(response:data:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","title":"trace(response:data:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"text":"response","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLResponse","text":"URLResponse","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"data","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"type":"topic","abstract":[{"type":"text","text":"Log an HTTP response."}],"required":true,"role":"symbol"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)"},"metadata":{"required":true,"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"response"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLResponse","text":"URLResponse","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"data"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?)"}],"externalID":"s:5Auth06LoggerP5trace8response4dataySo13NSURLResponseC_10Foundation4DataVSgtF","roleHeading":"Instance Method","title":"trace(response:data:)"},"abstract":[{"type":"text","text":"Log an HTTP response."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger\/trace(response:data:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"text":"response","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URLResponse","preciseIdentifier":"c:objc(cs)NSURLResponse","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"data"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?)"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(response:data:)":{"kind":"symbol","title":"trace(response:data:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Log an HTTP response."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"response"},{"kind":"text","text":": "},{"text":"URLResponse","preciseIdentifier":"c:objc(cs)NSURLResponse","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"data","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"url":"\/documentation\/auth0\/logger\/trace(response:data:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"kind":"symbol","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","type":"topic","title":"Logger","navigatorTitle":[{"kind":"identifier","text":"Logger"}],"url":"\/documentation\/auth0\/logger"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/logger/trace(url:source:).json b/docs/data/documentation/auth0/logger/trace(url:source:).json index 374f3d9c..e669a210 100644 --- a/docs/data/documentation/auth0/logger/trace(url:source:).json +++ b/docs/data/documentation/auth0/logger/trace(url:source:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"trace","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"source"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/logger\/trace(url:source:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth06LoggerP5trace3url6sourcey10Foundation3URLV_SSSgtF","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"text":"url","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":", "},{"text":"source","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"roleHeading":"Instance Method","required":true,"title":"trace(url:source:)","symbolKind":"method"},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Log a URL."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(url:source:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)","kind":"symbol","url":"\/documentation\/auth0\/logger\/trace(url:source:)","title":"trace(url:source:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"kind":"text","text":"("},{"text":"url","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":", "},{"text":"source","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"abstract":[{"text":"Log a URL.","type":"text"}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Logger","kind":"identifier"}],"navigatorTitle":[{"text":"Logger","kind":"identifier"}],"abstract":[{"type":"text","text":"Logger for debugging purposes."}],"url":"\/documentation\/auth0\/logger","title":"Logger","role":"symbol","type":"topic"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"source"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"method","title":"trace(url:source:)","externalID":"s:5Auth06LoggerP5trace3url6sourcey10Foundation3URLV_SSSgtF","required":true},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"url"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"text":", ","kind":"text"},{"text":"source","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?)","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/logger\/trace(url:source:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Log a URL.","type":"text"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"kind":"symbol","abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","type":"topic","title":"Logger","navigatorTitle":[{"kind":"identifier","text":"Logger"}],"url":"\/documentation\/auth0\/logger"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(url:source:)":{"required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"text":"(","kind":"text"},{"text":"url","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"text":", ","kind":"text"},{"text":"source","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"kind":"symbol","abstract":[{"type":"text","text":"Log a URL."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)","type":"topic","title":"trace(url:source:)","url":"\/documentation\/auth0\/logger\/trace(url:source:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror.json b/docs/data/documentation/auth0/managementerror.json index e68e0cd8..34aabc0d 100644 --- a/docs/data/documentation/auth0/managementerror.json +++ b/docs/data/documentation/auth0/managementerror.json @@ -1 +1 @@ -{"relationshipsSections":[{"title":"Conforms To","kind":"relationships","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror"]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"languages":["swift"]}]}],"metadata":{"externalID":"s:5Auth015ManagementErrorV","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"ManagementError","symbolKind":"struct","roleHeading":"Structure","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)"]},{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode"]},{"title":"Default Implementations","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"url":"\/documentation\/auth0\/managementerror\/cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","type":"topic","title":"cause","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"role":"collectionGroup","title":"LocalizedError Implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","type":"topic","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","kind":"article"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/code":{"url":"\/documentation\/auth0\/managementerror\/code","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","role":"symbol","abstract":[{"text":"The code of the error as a string.","type":"text"}],"kind":"symbol","title":"code","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"role":"collectionGroup","kind":"article","title":"Auth0Error Implementations","url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","type":"topic","abstract":[]},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/statusCode":{"url":"\/documentation\/auth0\/managementerror\/statuscode","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","role":"symbol","abstract":[{"text":"HTTP status code of the response.","type":"text"}],"kind":"symbol","title":"statusCode","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/info":{"url":"\/documentation\/auth0\/managementerror\/info","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"role":"symbol","title":"info","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info","abstract":[{"text":"Additional information about the error.","type":"text"}]},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/debugDescription":{"url":"\/documentation\/auth0\/managementerror\/debugdescription","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","role":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"url":"\/documentation\/auth0\/managementerror\/equatable-implementations","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","role":"collectionGroup","abstract":[],"kind":"article","title":"Equatable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/init(info:statusCode:)":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)","title":"init(info:statusCode:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)"}}} \ No newline at end of file +{"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror"]}],"metadata":{"roleHeading":"Structure","title":"ManagementError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"role":"symbol","externalID":"s:5Auth015ManagementErrorV","symbolKind":"struct","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"modules":[{"name":"Auth0"}]},"kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}]}]}],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode"],"title":"Instance Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations"],"generated":true,"title":"Default Implementations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/init(info:statusCode:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"info","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"title":"init(info:statusCode:)","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"type":"topic"},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/info":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}],"title":"info","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/info","abstract":[{"type":"text","text":"Additional information about the error."}],"type":"topic"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/statusCode":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"title":"statusCode","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/statuscode","abstract":[{"type":"text","text":"HTTP status code of the response."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"?","kind":"text"}],"title":"cause","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","role":"collectionGroup","title":"Equatable Implementations","abstract":[],"url":"\/documentation\/auth0\/managementerror\/equatable-implementations","type":"topic"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"title":"Foundation.LocalizedError","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"url":"\/documentation\/auth0\/auth0error","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"kind":"symbol","title":"Auth0Error"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"type":"topic","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","title":"LocalizedError Implementations","role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"title":"Auth0APIError","url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","abstract":[],"type":"topic","role":"collectionGroup","kind":"article","title":"Auth0Error Implementations"},"doc://com.auth0.Auth0/s5ErrorP":{"type":"unresolvable","title":"Swift.Error","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/debugDescription":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"debugDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/managementerror\/debugdescription","type":"topic"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"type":"unresolvable","title":"Swift.CustomDebugStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/code":{"url":"\/documentation\/auth0\/managementerror\/code","kind":"symbol","title":"code","type":"topic","abstract":[{"text":"The code of the error as a string.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/!=(_:_:).json b/docs/data/documentation/auth0/managementerror/!=(_:_:).json index 9d69e19d..bd478ef8 100644 --- a/docs/data/documentation/auth0/managementerror/!=(_:_:).json +++ b/docs/data/documentation/auth0/managementerror/!=(_:_:).json @@ -1 +1 @@ -{"sections":[],"metadata":{"extendedModule":"Swift","roleHeading":"Operator","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth015ManagementErrorV","title":"!=(_:_:)","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"symbolKind":"op","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/!=(_:_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/!=(_:_:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"!=(_:_:)","type":"topic","url":"\/documentation\/auth0\/managementerror\/!=(_:_:)","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"url":"\/documentation\/auth0\/managementerror\/equatable-implementations","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","role":"collectionGroup","abstract":[],"kind":"article","title":"Equatable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations"]]},"abstract":[{"type":"text","text":"Inherited from "},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"symbolKind":"op","title":"!=(_:_:)","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"roleHeading":"Operator","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth015ManagementErrorV","extendedModule":"Swift","role":"symbol"},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","role":"collectionGroup","title":"Equatable Implementations","abstract":[],"url":"\/documentation\/auth0\/managementerror\/equatable-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/!=(_:_:)":{"role":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"kind":"symbol","url":"\/documentation\/auth0\/managementerror\/!=(_:_:)","title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/==(_:_:).json b/docs/data/documentation/auth0/managementerror/==(_:_:).json index f302dc6c..b79c56a9 100644 --- a/docs/data/documentation/auth0/managementerror/==(_:_:).json +++ b/docs/data/documentation/auth0/managementerror/==(_:_:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/==(_:_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"roleHeading":"Operator","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth015ManagementErrorV2eeoiySbAC_ACtFZ","role":"symbol","symbolKind":"op","modules":[{"name":"Auth0"}],"title":"==(_:_:)","extendedModule":"Auth0"},"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"=="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"lhs","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"url":"\/documentation\/auth0\/managementerror\/equatable-implementations","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","role":"collectionGroup","abstract":[],"kind":"article","title":"Equatable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/==(_:_:)":{"url":"\/documentation\/auth0\/managementerror\/==(_:_:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations"]]},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/==(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"metadata":{"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","title":"==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":", "},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"symbolKind":"op","externalID":"s:5Auth015ManagementErrorV2eeoiySbAC_ACtFZ","roleHeading":"Operator","role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"platforms":["iOS"],"languages":["swift"]}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/==(_:_:)":{"role":"symbol","type":"topic","abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/auth0\/managementerror\/==(_:_:)","title":"==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","role":"collectionGroup","title":"Equatable Implementations","abstract":[],"url":"\/documentation\/auth0\/managementerror\/equatable-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/auth0error-implementations.json b/docs/data/documentation/auth0/managementerror/auth0error-implementations.json index 9789543e..7f96d37b 100644 --- a/docs/data/documentation/auth0/managementerror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/managementerror/auth0error-implementations.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"topicSections":[{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription"]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/auth0error-implementations"]}],"kind":"article","schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"title":"Auth0Error Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/errorDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/managementerror\/errordescription","type":"topic","title":"errorDescription","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/localizedDescription":{"role":"symbol","kind":"symbol","title":"localizedDescription","url":"\/documentation\/auth0\/managementerror\/localizeddescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"modules":[{"name":"Auth0"}],"title":"Auth0Error Implementations","roleHeading":"API Collection","role":"collectionGroup"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"kind":"article","sections":[],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/auth0error-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription"],"generated":true,"title":"Instance Properties"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/localizedDescription":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","url":"\/documentation\/auth0\/managementerror\/localizeddescription","abstract":[{"type":"text","text":"Description of the error."}],"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","kind":"symbol","title":"localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/errorDescription":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/managementerror\/errordescription","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/cause.json b/docs/data/documentation/auth0/managementerror/cause.json index 3504b7a9..404c921b 100644 --- a/docs/data/documentation/auth0/managementerror/cause.json +++ b/docs/data/documentation/auth0/managementerror/cause.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"sections":[],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth015ManagementErrorV5causes0C0_pSgvp","title":"cause","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"text":"?","kind":"text"}],"role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/cause"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","abstract":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"url":"\/documentation\/auth0\/managementerror\/cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","type":"topic","title":"cause","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/managementerror\/cause"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"title":"cause","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","symbolKind":"property","externalID":"s:5Auth015ManagementErrorV5causes0C0_pSgvp"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"?","kind":"text"}],"title":"cause","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/code.json b/docs/data/documentation/auth0/managementerror/code.json index 0468986a..1b943b3c 100644 --- a/docs/data/documentation/auth0/managementerror/code.json +++ b/docs/data/documentation/auth0/managementerror/code.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"metadata":{"title":"code","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol","externalID":"s:5Auth015ManagementErrorV4codeSSvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property"},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/code"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code"},"abstract":[{"type":"text","text":"The code of the error as a string."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/code":{"url":"\/documentation\/auth0\/managementerror\/code","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","role":"symbol","abstract":[{"text":"The code of the error as a string.","type":"text"}],"kind":"symbol","title":"code","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/code"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"abstract":[{"type":"text","text":"The code of the error as a string."}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"code","externalID":"s:5Auth015ManagementErrorV4codeSSvp","symbolKind":"property","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/code":{"url":"\/documentation\/auth0\/managementerror\/code","kind":"symbol","title":"code","type":"topic","abstract":[{"text":"The code of the error as a string.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/debugdescription.json b/docs/data/documentation/auth0/managementerror/debugdescription.json index 1ed34d5d..aa0fdb4a 100644 --- a/docs/data/documentation/auth0/managementerror/debugdescription.json +++ b/docs/data/documentation/auth0/managementerror/debugdescription.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"style":"important","type":"aside","content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"text":" only.","type":"text"}],"type":"paragraph"}],"name":"Important"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/debugdescription"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","metadata":{"externalID":"s:5Auth015ManagementErrorV16debugDescriptionSSvp","title":"debugDescription","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol"},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/debugDescription":{"url":"\/documentation\/auth0\/managementerror\/debugdescription","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","role":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","role":"symbol","externalID":"s:5Auth015ManagementErrorV16debugDescriptionSSvp","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"debugDescription","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/debugdescription"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"name":"Important","type":"aside","content":[{"inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"text":" only.","type":"text"}],"type":"paragraph"}],"style":"important"}]}],"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/debugDescription":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"debugDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/managementerror\/debugdescription","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/equatable-implementations.json b/docs/data/documentation/auth0/managementerror/equatable-implementations.json index 347ca2ff..d60b0968 100644 --- a/docs/data/documentation/auth0/managementerror/equatable-implementations.json +++ b/docs/data/documentation/auth0/managementerror/equatable-implementations.json @@ -1 +1 @@ -{"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)"],"title":"Operators"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations"},"metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"Equatable Implementations"},"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/!=(_:_:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"!=(_:_:)","type":"topic","url":"\/documentation\/auth0\/managementerror\/!=(_:_:)","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/==(_:_:)":{"url":"\/documentation\/auth0\/managementerror\/==(_:_:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"==(_:_:)"}}} \ No newline at end of file +{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/equatable-implementations"]}],"topicSections":[{"generated":true,"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"title":"Equatable Implementations","modules":[{"name":"Auth0"}],"role":"collectionGroup","roleHeading":"API Collection"},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/==(_:_:)":{"role":"symbol","type":"topic","abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/auth0\/managementerror\/==(_:_:)","title":"==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/!=(_:_:)":{"role":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"kind":"symbol","url":"\/documentation\/auth0\/managementerror\/!=(_:_:)","title":"!=(_:_:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/errordescription.json b/docs/data/documentation/auth0/managementerror/errordescription.json index f71d8808..47aee1b9 100644 --- a/docs/data/documentation/auth0/managementerror/errordescription.json +++ b/docs/data/documentation/auth0/managementerror/errordescription.json @@ -1 +1 @@ -{"metadata":{"title":"errorDescription","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"extendedModule":"Auth0","role":"symbol"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]},{"content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"name":"Important","style":"important","type":"aside","content":[{"inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"text":" only.","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/errordescription"]}],"kind":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"role":"collectionGroup","kind":"article","title":"Auth0Error Implementations","url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/errorDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/managementerror\/errordescription","type":"topic","title":"errorDescription","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","extendedModule":"Auth0","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"errorDescription","roleHeading":"Instance Property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations"]]},"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"name":"Important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"type":"text","text":" only."}]}],"type":"aside","style":"important"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Description of the error."}],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/errorDescription":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/managementerror\/errordescription","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","abstract":[],"type":"topic","role":"collectionGroup","kind":"article","title":"Auth0Error Implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/failurereason.json b/docs/data/documentation/auth0/managementerror/failurereason.json index c620788e..19d37ac7 100644 --- a/docs/data/documentation/auth0/managementerror/failurereason.json +++ b/docs/data/documentation/auth0/managementerror/failurereason.json @@ -1 +1 @@ -{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations"]]},"metadata":{"extendedModule":"Foundation","platforms":[{"name":"iOS","deprecated":false,"beta":false,"unavailable":false,"introducedAt":"8.0"},{"deprecated":false,"name":"macOS","introducedAt":"10.10","unavailable":false,"beta":false},{"name":"tvOS","deprecated":false,"beta":false,"unavailable":false,"introducedAt":"9.0"},{"unavailable":false,"beta":false,"deprecated":false,"name":"watchOS","introducedAt":"2.0"}],"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"title":"failureReason","roleHeading":"Instance Property","role":"symbol"},"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"type":"text","text":"."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason"},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/failurereason"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"role":"collectionGroup","title":"LocalizedError Implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","type":"topic","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/failureReason":{"url":"\/documentation\/auth0\/managementerror\/failurereason","kind":"symbol","title":"failureReason","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","abstract":[]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.failureReason","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"title":"failureReason","platforms":[{"deprecated":false,"unavailable":false,"name":"iOS","beta":false,"introducedAt":"8.0"},{"introducedAt":"10.10","beta":false,"unavailable":false,"name":"macOS","deprecated":false},{"beta":false,"introducedAt":"9.0","name":"tvOS","deprecated":false,"unavailable":false},{"name":"watchOS","deprecated":false,"introducedAt":"2.0","beta":false,"unavailable":false}],"role":"symbol","externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","extendedModule":"Foundation"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason"},"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/failurereason"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"type":"topic","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","title":"LocalizedError Implementations","role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/failureReason":{"abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","url":"\/documentation\/auth0\/managementerror\/failurereason","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","kind":"symbol","title":"failureReason"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/helpanchor.json b/docs/data/documentation/auth0/managementerror/helpanchor.json index e6e6b5a1..57925c35 100644 --- a/docs/data/documentation/auth0/managementerror/helpanchor.json +++ b/docs/data/documentation/auth0/managementerror/helpanchor.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/managementerror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"extendedModule":"Foundation","roleHeading":"Instance Property","role":"symbol","title":"helpAnchor","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"platforms":[{"introducedAt":"8.0","deprecated":false,"name":"iOS","unavailable":false,"beta":false},{"introducedAt":"10.10","name":"macOS","beta":false,"unavailable":false,"deprecated":false},{"beta":false,"introducedAt":"9.0","unavailable":false,"deprecated":false,"name":"tvOS"},{"deprecated":false,"introducedAt":"2.0","unavailable":false,"name":"watchOS","beta":false}],"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"symbolKind":"property"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations"]]},"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.helpAnchor","type":"codeVoice"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/helpAnchor":{"role":"symbol","title":"helpAnchor","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","type":"topic","url":"\/documentation\/auth0\/managementerror\/helpanchor","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"role":"collectionGroup","title":"LocalizedError Implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","type":"topic","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"helpAnchor","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"platforms":[{"deprecated":false,"introducedAt":"8.0","beta":false,"unavailable":false,"name":"iOS"},{"introducedAt":"10.10","deprecated":false,"unavailable":false,"beta":false,"name":"macOS"},{"beta":false,"name":"tvOS","unavailable":false,"deprecated":false,"introducedAt":"9.0"},{"name":"watchOS","introducedAt":"2.0","unavailable":false,"beta":false,"deprecated":false}],"roleHeading":"Instance Property","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","extendedModule":"Foundation","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol"},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.helpAnchor","type":"codeVoice"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/helpanchor"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/helpAnchor":{"abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol","url":"\/documentation\/auth0\/managementerror\/helpanchor","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","kind":"symbol","title":"helpAnchor"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"type":"topic","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","title":"LocalizedError Implementations","role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/info.json b/docs/data/documentation/auth0/managementerror/info.json index 3e2443d5..ec8383d1 100644 --- a/docs/data/documentation/auth0/managementerror/info.json +++ b/docs/data/documentation/auth0/managementerror/info.json @@ -1 +1 @@ -{"sections":[],"metadata":{"roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"info","externalID":"s:5Auth015ManagementErrorV4infoSDySSypGvp","symbolKind":"property"},"abstract":[{"type":"text","text":"Additional information about the error."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/info"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/info":{"url":"\/documentation\/auth0\/managementerror\/info","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"role":"symbol","title":"info","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info","abstract":[{"text":"Additional information about the error.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/info"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","metadata":{"externalID":"s:5Auth015ManagementErrorV4infoSDySSypGvp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","symbolKind":"property","title":"info"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info"},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Additional information about the error."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/info":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}],"title":"info","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/info","abstract":[{"type":"text","text":"Additional information about the error."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/init(info:statuscode:).json b/docs/data/documentation/auth0/managementerror/init(info:statuscode:).json index 84c887d0..c1f70405 100644 --- a/docs/data/documentation/auth0/managementerror/init(info:statuscode:).json +++ b/docs/data/documentation/auth0/managementerror/init(info:statuscode:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/init(info:statuscode:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)"},"metadata":{"externalID":"s:5Auth015ManagementErrorV4info10statusCodeACSDySSypG_Sitcfc","role":"symbol","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"modules":[{"name":"Auth0"}],"title":"init(info:statusCode:)","roleHeading":"Initializer"},"abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"info","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"JSON response from Auth0."}]}]},{"content":[{"inlineContent":[{"type":"text","text":"HTTP status code of the response."}],"type":"paragraph"}],"name":"statusCode"}],"kind":"parameters"},{"content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"A new ","type":"text"},{"type":"codeVoice","code":"ManagementError"},{"type":"text","text":"."}]}],"kind":"content"}],"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/init(info:statusCode:)":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)","title":"init(info:statusCode:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"JSON response from Auth0.","type":"text"}],"type":"paragraph"}],"name":"info"},{"content":[{"inlineContent":[{"type":"text","text":"HTTP status code of the response."}],"type":"paragraph"}],"name":"statusCode"}],"kind":"parameters"},{"content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A new ","type":"text"},{"code":"ManagementError","type":"codeVoice"},{"text":".","type":"text"}]}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/init(info:statuscode:)"]}],"abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"metadata":{"role":"symbol","externalID":"s:5Auth015ManagementErrorV4info10statusCodeACSDySSypG_Sitcfc","roleHeading":"Initializer","symbolKind":"init","title":"init(info:statusCode:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"statusCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"text":")","kind":"text"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)"},"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/init(info:statusCode:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"info","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"title":"init(info:statusCode:)","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/localizeddescription.json b/docs/data/documentation/auth0/managementerror/localizeddescription.json index 10ab28e4..a0b58804 100644 --- a/docs/data/documentation/auth0/managementerror/localizeddescription.json +++ b/docs/data/documentation/auth0/managementerror/localizeddescription.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations"]]},"metadata":{"symbolKind":"property","extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth015ManagementErrorV","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"localizedDescription"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]},{"content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"style":"important","content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"text":" only.","type":"text"}],"type":"paragraph"}],"name":"Important","type":"aside"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription"},"abstract":[{"type":"text","text":"Description of the error."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/localizedDescription":{"role":"symbol","kind":"symbol","title":"localizedDescription","url":"\/documentation\/auth0\/managementerror\/localizeddescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"role":"collectionGroup","kind":"article","title":"Auth0Error Implementations","url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","type":"topic","abstract":[]}}} \ No newline at end of file +{"sections":[],"abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","metadata":{"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth015ManagementErrorV","symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","extendedModule":"Auth0","title":"localizedDescription"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"style":"important","type":"aside","content":[{"inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"type":"strong","inlineContent":[{"text":"debugging","type":"text"}]},{"type":"text","text":" only."}],"type":"paragraph"}],"name":"Important"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/localizeddescription"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/localizedDescription":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","url":"\/documentation\/auth0\/managementerror\/localizeddescription","abstract":[{"type":"text","text":"Description of the error."}],"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","kind":"symbol","title":"localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","abstract":[],"type":"topic","role":"collectionGroup","kind":"article","title":"Auth0Error Implementations"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/localizederror-implementations.json b/docs/data/documentation/auth0/managementerror/localizederror-implementations.json index 5e8a349b..36513d01 100644 --- a/docs/data/documentation/auth0/managementerror/localizederror-implementations.json +++ b/docs/data/documentation/auth0/managementerror/localizederror-implementations.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"metadata":{"role":"collectionGroup","title":"LocalizedError Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"article","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/localizederror-implementations"]}],"sections":[],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion"],"generated":true}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/helpAnchor":{"role":"symbol","title":"helpAnchor","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","type":"topic","url":"\/documentation\/auth0\/managementerror\/helpanchor","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/failureReason":{"url":"\/documentation\/auth0\/managementerror\/failurereason","kind":"symbol","title":"failureReason","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/recoverySuggestion":{"kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion","url":"\/documentation\/auth0\/managementerror\/recoverysuggestion","abstract":[],"type":"topic","title":"recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/localizederror-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"article","schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"sections":[],"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion"],"title":"Instance Properties"}],"metadata":{"role":"collectionGroup","modules":[{"name":"Auth0"}],"title":"LocalizedError Implementations","roleHeading":"API Collection"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/recoverySuggestion":{"title":"recoverySuggestion","kind":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/managementerror\/recoverysuggestion","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/failureReason":{"abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","url":"\/documentation\/auth0\/managementerror\/failurereason","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","kind":"symbol","title":"failureReason"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/helpAnchor":{"abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol","url":"\/documentation\/auth0\/managementerror\/helpanchor","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","kind":"symbol","title":"helpAnchor"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/recoverysuggestion.json b/docs/data/documentation/auth0/managementerror/recoverysuggestion.json index ce3da1cf..26c77084 100644 --- a/docs/data/documentation/auth0/managementerror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/managementerror/recoverysuggestion.json @@ -1 +1 @@ -{"metadata":{"title":"recoverySuggestion","platforms":[{"name":"iOS","introducedAt":"8.0","deprecated":false,"unavailable":false,"beta":false},{"name":"macOS","introducedAt":"10.10","deprecated":false,"unavailable":false,"beta":false},{"unavailable":false,"name":"tvOS","introducedAt":"9.0","deprecated":false,"beta":false},{"name":"watchOS","deprecated":false,"unavailable":false,"beta":false,"introducedAt":"2.0"}],"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","symbolKind":"property","roleHeading":"Instance Property","role":"symbol","extendedModule":"Foundation","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.recoverySuggestion"},{"type":"text","text":"."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"role":"collectionGroup","title":"LocalizedError Implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","type":"topic","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/recoverySuggestion":{"kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion","url":"\/documentation\/auth0\/managementerror\/recoverysuggestion","abstract":[],"type":"topic","title":"recoverySuggestion"}}} \ No newline at end of file +{"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"platforms":[{"name":"iOS","unavailable":false,"introducedAt":"8.0","deprecated":false,"beta":false},{"unavailable":false,"name":"macOS","deprecated":false,"beta":false,"introducedAt":"10.10"},{"beta":false,"deprecated":false,"introducedAt":"9.0","name":"tvOS","unavailable":false},{"introducedAt":"2.0","deprecated":false,"name":"watchOS","unavailable":false,"beta":false}],"roleHeading":"Instance Property","extendedModule":"Foundation","externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"role":"symbol","symbolKind":"property","title":"recoverySuggestion"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/recoverySuggestion":{"title":"recoverySuggestion","kind":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/managementerror\/recoverysuggestion","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"type":"topic","url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","title":"LocalizedError Implementations","role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/statuscode.json b/docs/data/documentation/auth0/managementerror/statuscode.json index f78bad64..ee16a2f4 100644 --- a/docs/data/documentation/auth0/managementerror/statuscode.json +++ b/docs/data/documentation/auth0/managementerror/statuscode.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","interfaceLanguage":"swift"},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth015ManagementErrorV10statusCodeSivp","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"title":"statusCode"},"kind":"symbol","abstract":[{"type":"text","text":"HTTP status code of the response."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/statuscode"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/statusCode":{"url":"\/documentation\/auth0\/managementerror\/statuscode","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","role":"symbol","abstract":[{"text":"HTTP status code of the response.","type":"text"}],"kind":"symbol","title":"statusCode","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"languages":["swift"],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/statuscode"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth015ManagementErrorV10statusCodeSivp","role":"symbol","title":"statusCode","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}]},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode"},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/statusCode":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"title":"statusCode","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/statuscode","abstract":[{"type":"text","text":"HTTP status code of the response."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementobject.json b/docs/data/documentation/auth0/managementobject.json index 37e80632..2c4ba35e 100644 --- a/docs/data/documentation/auth0/managementobject.json +++ b/docs/data/documentation/auth0/managementobject.json @@ -1 +1 @@ -{"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementObject"},{"kind":"text","text":" = ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/managementobject"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"externalID":"s:5Auth016ManagementObjecta","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"roleHeading":"Type Alias","symbolKind":"typealias","role":"symbol","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"ManagementObject"}],"title":"ManagementObject"},"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject","title":"ManagementObject","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/managementobject"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},"abstract":[{"type":"text","text":"A dictionary containing a user profile."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementObject"},{"kind":"text","text":" = ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"title":"ManagementObject","modules":[{"name":"Auth0"}],"symbolKind":"typealias","externalID":"s:5Auth016ManagementObjecta","role":"symbol","roleHeading":"Type Alias","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","type":"topic","url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementresult.json b/docs/data/documentation/auth0/managementresult.json index d2145db1..03277d6a 100644 --- a/docs/data/documentation/auth0/managementresult.json +++ b/docs/data/documentation/auth0/managementresult.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementResult","kind":"identifier"},{"text":"<","kind":"text"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":"> = "},{"kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO","text":"Result"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementResulta1Txmfp"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"text":">","kind":"text"}],"languages":["swift"]}]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementResult","kind":"identifier"}],"modules":[{"name":"Auth0"}],"symbolKind":"typealias","role":"symbol","roleHeading":"Type Alias","navigatorTitle":[{"text":"ManagementResult","kind":"identifier"}],"title":"ManagementResult","externalID":"s:5Auth016ManagementResulta"},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementresult"]}],"abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Management API operations.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementResult":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"ManagementResult","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementResult","kind":"identifier"}],"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Management API operations.","type":"text"}],"url":"\/documentation\/auth0\/managementresult","title":"ManagementResult","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Management API operations.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"text":"ManagementResult","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":"> = ","kind":"text"},{"text":"Result","preciseIdentifier":"s:s6ResultO","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth016ManagementResulta1Txmfp"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult"},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementresult"]}],"kind":"symbol","sections":[],"metadata":{"navigatorTitle":[{"text":"ManagementResult","kind":"identifier"}],"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementResult"}],"externalID":"s:5Auth016ManagementResulta","roleHeading":"Type Alias","symbolKind":"typealias","role":"symbol","title":"ManagementResult"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementResult":{"navigatorTitle":[{"kind":"identifier","text":"ManagementResult"}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/managementresult","type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementResult"}],"title":"ManagementResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Management API operations."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype.json b/docs/data/documentation/auth0/passwordlesstype.json index f8054f8e..ed2c56da 100644 --- a/docs/data/documentation/auth0/passwordlesstype.json +++ b/docs/data/documentation/auth0/passwordlesstype.json @@ -1 +1 @@ -{"topicSections":[{"title":"Enumeration Cases","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)"],"title":"Initializers"},{"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"],"generated":true}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/SH","doc:\/\/com.auth0.Auth0\/SY"],"type":"conformsTo","title":"Conforms To","kind":"relationships"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"symbolKind":"enum","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType","externalID":"s:5Auth016PasswordlessTypeO","roleHeading":"Enumeration"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}]}]}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/passwordlesstype"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/androidLink":{"url":"\/documentation\/auth0\/passwordlesstype\/androidlink","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"androidLink"}],"title":"PasswordlessType.androidLink","abstract":[{"type":"text","text":"Android App Link."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/iOSLink":{"url":"\/documentation\/auth0\/passwordlesstype\/ioslink","type":"topic","fragments":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"text":"iOSLink","kind":"identifier"}],"title":"PasswordlessType.iOSLink","abstract":[{"type":"text","text":"Universal Link."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/Equatable-Implementations":{"url":"\/documentation\/auth0\/passwordlesstype\/equatable-implementations","type":"topic","title":"Equatable Implementations","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","kind":"article"},"doc://com.auth0.Auth0/SY":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SY","title":"Swift.RawRepresentable"},"doc://com.auth0.Auth0/SH":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SH","title":"Swift.Hashable"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","kind":"article","type":"topic","title":"RawRepresentable Implementations","abstract":[],"role":"collectionGroup","url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/code":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"}],"type":"topic","title":"PasswordlessType.code","abstract":[{"type":"text","text":"Simple OTP code sent by email or SMS."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/code"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/init(rawValue:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"?("},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":")"}],"type":"topic","title":"init(rawValue:)","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/webLink":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"webLink"}],"type":"topic","title":"PasswordlessType.webLink","abstract":[{"type":"text","text":"Regular Web HTTP link (web only, uses a redirect)."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/weblink"}}} \ No newline at end of file +{"kind":"symbol","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"title":"Enumeration Cases","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)"],"title":"Initializers"},{"title":"Default Implementations","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"]}],"sections":[],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/SH","doc:\/\/com.auth0.Auth0\/SY"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Enumeration","role":"symbol","symbolKind":"enum","title":"PasswordlessType","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"externalID":"s:5Auth016PasswordlessTypeO","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/Equatable-Implementations":{"type":"topic","url":"\/documentation\/auth0\/passwordlesstype\/equatable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","title":"Equatable Implementations","abstract":[],"role":"collectionGroup","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/init(rawValue:)":{"fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"type":"topic","title":"init(rawValue:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/androidLink":{"title":"PasswordlessType.androidLink","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"androidLink"}],"url":"\/documentation\/auth0\/passwordlesstype\/androidlink","abstract":[{"type":"text","text":"Android App Link."}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/webLink":{"abstract":[{"text":"Regular Web HTTP link (web only, uses a redirect).","type":"text"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webLink","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/weblink","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","kind":"symbol","title":"PasswordlessType.webLink"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/iOSLink":{"title":"PasswordlessType.iOSLink","type":"topic","abstract":[{"type":"text","text":"Universal Link."}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/ioslink","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"text":"iOSLink","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink"},"doc://com.auth0.Auth0/SH":{"identifier":"doc:\/\/com.auth0.Auth0\/SH","title":"Swift.Hashable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/code":{"abstract":[{"text":"Simple OTP code sent by email or SMS.","type":"text"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/code","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","kind":"symbol","title":"PasswordlessType.code"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"title":"RawRepresentable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations","kind":"article","type":"topic","abstract":[]},"doc://com.auth0.Auth0/SY":{"identifier":"doc:\/\/com.auth0.Auth0\/SY","title":"Swift.RawRepresentable","type":"unresolvable"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype/!=(_:_:).json b/docs/data/documentation/auth0/passwordlesstype/!=(_:_:).json index 4f1c5858..94452a7d 100644 --- a/docs/data/documentation/auth0/passwordlesstype/!=(_:_:).json +++ b/docs/data/documentation/auth0/passwordlesstype/!=(_:_:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Inherited from "},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/!=(_:_:)"]}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"title":"!=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"symbolKind":"op","role":"symbol","extendedModule":"Swift","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth016PasswordlessTypeO","roleHeading":"Operator","modules":[{"relatedModules":["Swift"],"name":"Auth0"}]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/Equatable-Implementations":{"url":"\/documentation\/auth0\/passwordlesstype\/equatable-implementations","type":"topic","title":"Equatable Implementations","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/!=(_:_:)":{"title":"!=(_:_:)","url":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","role":"symbol","kind":"symbol","abstract":[],"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations"]]},"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/!=(_:_:)"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"metadata":{"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth016PasswordlessTypeO","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"title":"!=(_:_:)","extendedModule":"Swift","symbolKind":"op","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"roleHeading":"Operator","role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/Equatable-Implementations":{"type":"topic","url":"\/documentation\/auth0\/passwordlesstype\/equatable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","title":"Equatable Implementations","abstract":[],"role":"collectionGroup","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","kind":"symbol","abstract":[],"title":"!=(_:_:)","url":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype/androidlink.json b/docs/data/documentation/auth0/passwordlesstype/androidlink.json index 5ddc7a65..5e27b543 100644 --- a/docs/data/documentation/auth0/passwordlesstype/androidlink.json +++ b/docs/data/documentation/auth0/passwordlesstype/androidlink.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Android App Link."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/androidlink"]}],"metadata":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"androidLink"}],"modules":[{"name":"Auth0"}],"symbolKind":"case","role":"symbol","roleHeading":"Case","externalID":"s:5Auth016PasswordlessTypeO11androidLinkyA2CmF","title":"PasswordlessType.androidLink"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"androidLink","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/androidLink":{"url":"\/documentation\/auth0\/passwordlesstype\/androidlink","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"androidLink"}],"title":"PasswordlessType.androidLink","abstract":[{"type":"text","text":"Android App Link."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"abstract":[{"text":"Android App Link.","type":"text"}],"metadata":{"title":"PasswordlessType.androidLink","roleHeading":"Case","symbolKind":"case","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"androidLink"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth016PasswordlessTypeO11androidLinkyA2CmF","role":"symbol"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"androidLink","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/androidlink"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/androidLink":{"title":"PasswordlessType.androidLink","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"androidLink"}],"url":"\/documentation\/auth0\/passwordlesstype\/androidlink","abstract":[{"type":"text","text":"Android App Link."}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype/code.json b/docs/data/documentation/auth0/passwordlesstype/code.json index 2958203c..47dedaef 100644 --- a/docs/data/documentation/auth0/passwordlesstype/code.json +++ b/docs/data/documentation/auth0/passwordlesstype/code.json @@ -1 +1 @@ -{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Simple OTP code sent by email or SMS."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/code"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"PasswordlessType.code","externalID":"s:5Auth016PasswordlessTypeO4codeyA2CmF","fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"}],"role":"symbol","symbolKind":"case","roleHeading":"Case"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/code":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"}],"type":"topic","title":"PasswordlessType.code","abstract":[{"type":"text","text":"Simple OTP code sent by email or SMS."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/code"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code"},"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/code"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"title":"PasswordlessType.code","modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"case","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"code","kind":"identifier"}],"roleHeading":"Case","externalID":"s:5Auth016PasswordlessTypeO4codeyA2CmF"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","abstract":[{"type":"text","text":"Simple OTP code sent by email or SMS."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/code":{"abstract":[{"text":"Simple OTP code sent by email or SMS.","type":"text"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/code","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","kind":"symbol","title":"PasswordlessType.code"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype/equatable-implementations.json b/docs/data/documentation/auth0/passwordlesstype/equatable-implementations.json index 0a80d210..859961b7 100644 --- a/docs/data/documentation/auth0/passwordlesstype/equatable-implementations.json +++ b/docs/data/documentation/auth0/passwordlesstype/equatable-implementations.json @@ -1 +1 @@ -{"topicSections":[{"title":"Operators","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/equatable-implementations"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"sections":[],"kind":"article","metadata":{"title":"Equatable Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/!=(_:_:)":{"title":"!=(_:_:)","url":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","role":"symbol","kind":"symbol","abstract":[],"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"minor":3,"major":0},"topicSections":[{"generated":true,"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/equatable-implementations"]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations"},"kind":"article","metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"Equatable Implementations","role":"collectionGroup"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","kind":"symbol","abstract":[],"title":"!=(_:_:)","url":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype/hash(into:).json b/docs/data/documentation/auth0/passwordlesstype/hash(into:).json index bc90954e..248250d1 100644 --- a/docs/data/documentation/auth0/passwordlesstype/hash(into:).json +++ b/docs/data/documentation/auth0/passwordlesstype/hash(into:).json @@ -1 +1 @@ -{"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"RawRepresentable.hash(into:)"},{"text":".","type":"text"}],"sections":[],"metadata":{"title":"hash(into:)","extendedModule":"Swift","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"constraints":[{"code":"Self","type":"codeVoice"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":" and "},{"code":"RawValue","type":"codeVoice"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}]},"roleHeading":"Instance Method","externalID":"s:SYsSHRzSH8RawValueSYRpzrlE4hash4intoys6HasherVz_tF::SYNTHESIZED::s:5Auth016PasswordlessTypeO","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"role":"symbol","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:s6HasherV","text":"Hasher","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"text":"into","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"hasher","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Hasher","kind":"typeIdentifier","preciseIdentifier":"s:s6HasherV"},{"text":")","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/hash(into:)"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","kind":"article","type":"topic","title":"RawRepresentable Implementations","abstract":[],"role":"collectionGroup","url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hash(into:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","url":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","type":"topic","abstract":[],"kind":"symbol","title":"hash(into:)","conformance":{"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"code":"Self","type":"codeVoice"},{"type":"text","text":" conforms to "},{"code":"Hashable","type":"codeVoice"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"RawValue"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"text":".","type":"text"}]},"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"text":": ","kind":"text"},{"kind":"keyword","text":"inout"},{"text":" ","kind":"text"},{"text":"Hasher","kind":"typeIdentifier","preciseIdentifier":"s:s6HasherV"},{"text":")","kind":"text"}]}}} \ No newline at end of file +{"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"RawRepresentable.hash(into:)"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"]]},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"text":"(","kind":"text"},{"text":"into","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"hasher","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"Hasher","preciseIdentifier":"s:s6HasherV"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/hash(into:)"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"roleHeading":"Instance Method","extendedModule":"Swift","externalID":"s:SYsSHRzSH8RawValueSYRpzrlE4hash4intoys6HasherVz_tF::SYNTHESIZED::s:5Auth016PasswordlessTypeO","title":"hash(into:)","symbolKind":"method","conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"RawValue"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}]},"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"text":"inout","kind":"keyword"},{"kind":"text","text":" "},{"kind":"typeIdentifier","preciseIdentifier":"s:s6HasherV","text":"Hasher"},{"text":")","kind":"text"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hash(into:)":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"text":" ","kind":"text"},{"text":"Hasher","kind":"typeIdentifier","preciseIdentifier":"s:s6HasherV"},{"text":")","kind":"text"}],"type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","conformance":{"constraints":[{"code":"Self","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":" and "},{"code":"RawValue","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"role":"symbol","title":"hash(into:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"title":"RawRepresentable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations","kind":"article","type":"topic","abstract":[]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype/hashvalue.json b/docs/data/documentation/auth0/passwordlesstype/hashvalue.json index 26c9c413..57149fcc 100644 --- a/docs/data/documentation/auth0/passwordlesstype/hashvalue.json +++ b/docs/data/documentation/auth0/passwordlesstype/hashvalue.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"]]},"sections":[],"kind":"symbol","abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"RawRepresentable.hashValue"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/hashvalue"]}],"metadata":{"modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"role":"symbol","symbolKind":"property","extendedModule":"Swift","externalID":"s:SYsSHRzSH8RawValueSYRpzrlE04hashB0Sivp::SYNTHESIZED::s:5Auth016PasswordlessTypeO","roleHeading":"Instance Property","title":"hashValue","conformance":{"constraints":[{"code":"Self","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":" and "},{"type":"codeVoice","code":"RawValue"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}]},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hashValue":{"role":"symbol","abstract":[],"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue","url":"\/documentation\/auth0\/passwordlesstype\/hashvalue","title":"hashValue","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"code":"Self","type":"codeVoice"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"RawValue"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}],"conformancePrefix":[{"text":"Conforms when","type":"text"}]},"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","kind":"article","type":"topic","title":"RawRepresentable Implementations","abstract":[],"role":"collectionGroup","url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"RawRepresentable.hashValue"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"]]},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"hashValue","role":"symbol","conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"type":"text","text":" conforms to "},{"code":"Hashable","type":"codeVoice"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"RawValue"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"text":".","type":"text"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}],"availabilityPrefix":[{"type":"text","text":"Available when"}]},"symbolKind":"property","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"extendedModule":"Swift","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"externalID":"s:SYsSHRzSH8RawValueSYRpzrlE04hashB0Sivp::SYNTHESIZED::s:5Auth016PasswordlessTypeO"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/hashvalue"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"title":"RawRepresentable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations","kind":"article","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hashValue":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype\/hashvalue","abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"type":"text","text":" and "},{"code":"RawValue","type":"codeVoice"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}]},"role":"symbol","title":"hashValue"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype/init(rawvalue:).json b/docs/data/documentation/auth0/passwordlesstype/init(rawvalue:).json index ca0bc471..d5b7a48e 100644 --- a/docs/data/documentation/auth0/passwordlesstype/init(rawvalue:).json +++ b/docs/data/documentation/auth0/passwordlesstype/init(rawvalue:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":")"}]}]}],"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"RawRepresentable.init(rawValue:)"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)"]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Initializer","modules":[{"name":"Auth0"}],"symbolKind":"init","title":"init(rawValue:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"rawValue"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"externalID":"s:5Auth016PasswordlessTypeO8rawValueACSgSS_tcfc"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/init(rawValue:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"?("},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":")"}],"type":"topic","title":"init(rawValue:)","abstract":[],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)","interfaceLanguage":"swift"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":")"}],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"modules":[{"name":"Auth0"}],"title":"init(rawValue:)","symbolKind":"init","externalID":"s:5Auth016PasswordlessTypeO8rawValueACSgSS_tcfc","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":")"}],"role":"symbol"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"RawRepresentable.init(rawValue:)","type":"codeVoice"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/init(rawValue:)":{"fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"type":"topic","title":"init(rawValue:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype/ioslink.json b/docs/data/documentation/auth0/passwordlesstype/ioslink.json index b4f51472..67353350 100644 --- a/docs/data/documentation/auth0/passwordlesstype/ioslink.json +++ b/docs/data/documentation/auth0/passwordlesstype/ioslink.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/ioslink"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","symbolKind":"case","modules":[{"name":"Auth0"}],"title":"PasswordlessType.iOSLink","roleHeading":"Case","externalID":"s:5Auth016PasswordlessTypeO7iOSLinkyA2CmF","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"iOSLink","kind":"identifier"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"iOSLink"}],"languages":["swift"]}]}],"abstract":[{"text":"Universal Link.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/iOSLink":{"url":"\/documentation\/auth0\/passwordlesstype\/ioslink","type":"topic","fragments":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"text":"iOSLink","kind":"identifier"}],"title":"PasswordlessType.iOSLink","abstract":[{"type":"text","text":"Universal Link."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink","kind":"symbol"}}} \ No newline at end of file +{"abstract":[{"text":"Universal Link.","type":"text"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"iOSLink"}],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"roleHeading":"Case","symbolKind":"case","fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"text":"iOSLink","kind":"identifier"}],"role":"symbol","externalID":"s:5Auth016PasswordlessTypeO7iOSLinkyA2CmF","modules":[{"name":"Auth0"}],"title":"PasswordlessType.iOSLink"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/ioslink"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/iOSLink":{"title":"PasswordlessType.iOSLink","type":"topic","abstract":[{"type":"text","text":"Universal Link."}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/ioslink","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"text":"iOSLink","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype/rawrepresentable-implementations.json b/docs/data/documentation/auth0/passwordlesstype/rawrepresentable-implementations.json index 011edd98..2aa6c479 100644 --- a/docs/data/documentation/auth0/passwordlesstype/rawrepresentable-implementations.json +++ b/docs/data/documentation/auth0/passwordlesstype/rawrepresentable-implementations.json @@ -1 +1 @@ -{"metadata":{"title":"RawRepresentable Implementations","roleHeading":"API Collection","role":"collectionGroup","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","interfaceLanguage":"swift"},"kind":"article","variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue"],"title":"Instance Properties"},{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)"],"title":"Instance Methods"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hashValue":{"role":"symbol","abstract":[],"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue","url":"\/documentation\/auth0\/passwordlesstype\/hashvalue","title":"hashValue","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"code":"Self","type":"codeVoice"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"RawValue"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}],"conformancePrefix":[{"text":"Conforms when","type":"text"}]},"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hash(into:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","url":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","type":"topic","abstract":[],"kind":"symbol","title":"hash(into:)","conformance":{"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"code":"Self","type":"codeVoice"},{"type":"text","text":" conforms to "},{"code":"Hashable","type":"codeVoice"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"RawValue"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"text":".","type":"text"}]},"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"text":": ","kind":"text"},{"kind":"keyword","text":"inout"},{"text":" ","kind":"text"},{"text":"Hasher","kind":"typeIdentifier","preciseIdentifier":"s:s6HasherV"},{"text":")","kind":"text"}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","interfaceLanguage":"swift"},"kind":"article","metadata":{"roleHeading":"API Collection","role":"collectionGroup","title":"RawRepresentable Implementations","modules":[{"name":"Auth0"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue"],"title":"Instance Properties"},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)"],"generated":true}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hashValue":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype\/hashvalue","abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"type":"text","text":" and "},{"code":"RawValue","type":"codeVoice"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}]},"role":"symbol","title":"hashValue"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hash(into:)":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"text":" ","kind":"text"},{"text":"Hasher","kind":"typeIdentifier","preciseIdentifier":"s:s6HasherV"},{"text":")","kind":"text"}],"type":"topic","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","conformance":{"constraints":[{"code":"Self","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":" and "},{"code":"RawValue","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"role":"symbol","title":"hash(into:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype/weblink.json b/docs/data/documentation/auth0/passwordlesstype/weblink.json index a326b7b8..0a482322 100644 --- a/docs/data/documentation/auth0/passwordlesstype/weblink.json +++ b/docs/data/documentation/auth0/passwordlesstype/weblink.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"metadata":{"title":"PasswordlessType.webLink","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth016PasswordlessTypeO7webLinkyA2CmF","roleHeading":"Case","symbolKind":"case","fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"webLink"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webLink","kind":"identifier"}],"languages":["swift"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","abstract":[{"text":"Regular Web HTTP link (web only, uses a redirect).","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/weblink"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"type":"topic","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/webLink":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"webLink"}],"type":"topic","title":"PasswordlessType.webLink","abstract":[{"type":"text","text":"Regular Web HTTP link (web only, uses a redirect)."}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/weblink"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"abstract":[{"text":"Regular Web HTTP link (web only, uses a redirect).","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/weblink"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"kind":"identifier","text":"webLink"}],"platforms":["iOS"],"languages":["swift"]}]}],"metadata":{"roleHeading":"Case","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"webLink"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth016PasswordlessTypeO7webLinkyA2CmF","title":"PasswordlessType.webLink","symbolKind":"case"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/webLink":{"abstract":[{"text":"Regular Web HTTP link (web only, uses a redirect).","type":"text"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webLink","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/weblink","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","kind":"symbol","title":"PasswordlessType.webLink"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"type":"topic","url":"\/documentation\/auth0\/passwordlesstype","abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","title":"PasswordlessType"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/refreshtokens.json b/docs/data/documentation/auth0/refreshtokens.json index 57fa61e8..7f21d7d0 100644 --- a/docs/data/documentation/auth0/refreshtokens.json +++ b/docs/data/documentation/auth0/refreshtokens.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"name":"Auth0"}],"role":"article","title":"Refresh Tokens: Common Errors","roleHeading":"Article"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","interfaceLanguage":"swift"},"kind":"article","primaryContentSections":[{"content":[{"anchor":"Overview","text":"Overview","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"Exchanging a refresh token for new credentials can produce the following errors, depending on the implementation of your app, and the configuration of your Auth0 application.","type":"text"}]},{"type":"heading","level":2,"anchor":"Unknown-or-invalid-refresh-token","text":"Unknown or invalid refresh token"},{"items":[{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"text":"Example error description:","type":"text"}]},{"text":" ","type":"text"},{"type":"codeVoice","code":"The credentials renewal failed. CAUSE: Unknown or invalid refresh token"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"Log event type:"}],"type":"strong"},{"text":" ","type":"text"},{"code":"fertft","type":"codeVoice"}]}]}],"type":"unorderedList"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This error means that Auth0 does not recognize the refresh token used to make the renewal request. Either an empty or garbage\/truncated\/padded token was sent, or the token is not valid anymore –it expired or was revoked."}]},{"text":"Common causes","level":3,"type":"heading","anchor":"Common-causes"},{"type":"heading","text":"Renewing the credentials after revoking the refresh token","anchor":"Renewing-the-credentials-after-revoking-the-refresh-token","level":4},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you revoke the refresh token –either through the Credentials Manager or the Authentication API client– you should not attempt to renew the credentials afterward. For example, by calling the "},{"code":"credentials()","type":"codeVoice"},{"text":" method of the Credentials Manager in another thread.","type":"text"}]},{"inlineContent":[{"type":"text","text":"Once a refresh token is revoked it can no longer be exchanged for new credentials."}],"type":"paragraph"},{"type":"heading","anchor":"Misconfiguration-of-the-absolute-lifetime-of-refresh-tokens","level":4,"text":"Misconfiguration of the absolute lifetime of refresh tokens"},{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration"},{"text":" of the refresh token should not be shorter than the lifetime of the access token. If the access token is valid for longer than the refresh token is, your app may issue renewal requests with expired refresh tokens. This could happen, for example, when using the ","type":"text"},{"code":"credentials()","type":"codeVoice"},{"text":" method of the Credentials Manager.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"Once a refresh token expires it can no longer be exchanged for new credentials.","type":"text"}]},{"type":"heading","level":4,"text":"Misconfiguration of the inactivity lifetime of refresh tokens","anchor":"Misconfiguration-of-the-inactivity-lifetime-of-refresh-tokens"},{"inlineContent":[{"text":"The ","type":"text"},{"overridingTitleInlineContent":[{"text":"inactivity lifetime","type":"text"}],"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","overridingTitle":"inactivity lifetime"},{"type":"text","text":" of the refresh token should not be shorter than the lifetime of the access token. If the access token is valid for longer than the refresh token is "},{"inlineContent":[{"type":"text","text":"while the user is inactive"}],"type":"emphasis"},{"text":", your app may issue renewal requests with expired refresh tokens. This could happen, for example, when using the ","type":"text"},{"code":"credentials()","type":"codeVoice"},{"type":"text","text":" method of the Credentials Manager while your app is backgrounded."}],"type":"paragraph"},{"inlineContent":[{"text":"Once a refresh token expires due to user inactivity it can no longer be exchanged for new credentials.","type":"text"}],"type":"paragraph"},{"level":2,"anchor":"Unsuccessful-Refresh-Token-exchange-reused-refresh-token-detected","type":"heading","text":"Unsuccessful Refresh Token exchange, reused refresh token detected"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Example error description:"}]},{"text":" ","type":"text"},{"code":"The credentials renewal failed. CAUSE: Unsuccessful Refresh Token exchange, reused refresh token detected","type":"codeVoice"}]}]},{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"text":"Log event type:","type":"text"}]},{"type":"text","text":" "},{"code":"ferrt","type":"codeVoice"}],"type":"paragraph"}]}],"type":"unorderedList"},{"inlineContent":[{"text":"You might encounter this error if you have ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation"},{"text":" enabled for your Auth0 application. It means that the refresh token used to make the renewal request has already been exchanged, and the ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-rotation","type":"reference"},{"type":"text","text":" has passed."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"Rotating refresh tokens are effectively single-use. The renewed credentials will come with a new refresh token, and the old one will be invalidated once the renew interval passes."}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"text":"In the absence of a bad actor, this error is typically a symptom of concurrency issues in your app.","type":"text"}]}]},{"level":3,"type":"heading","text":"Common causes","anchor":"Common-causes"},{"level":4,"text":"Multiple Credentials Manager instances","type":"heading","anchor":"Multiple-Credentials-Manager-instances"},{"inlineContent":[{"text":"If you are using the Credentials Manager to renew the credentials -either through the ","type":"text"},{"type":"codeVoice","code":"credentials()"},{"type":"text","text":" or the "},{"code":"renew()","type":"codeVoice"},{"text":" method- you should use a single Credentials Manager instance. While these methods are thread-safe, the Credentials Manager cannot synchronize them across instances.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"This can happen, for example, by using a computed property to get a Credentials Manager instance:"}],"type":"paragraph"},{"type":"codeListing","syntax":null,"code":["struct Services {"," \/\/ ❌ This will return a new instance every time"," var credentialsManager: CredentialsManager {"," return CredentialsManager(authentication: Auth0.authentication())"," }","}"]},{"text":"Using the Authentication API client to renew the credentials alongside the Credentials Manager","anchor":"Using-the-Authentication-API-client-to-renew-the-credentials-alongside-the-Credentials-Manager","type":"heading","level":4},{"type":"paragraph","inlineContent":[{"text":"If you are using the Credentials Manager to store and retrieve the credentials, you should not force renewals through the ","type":"text"},{"code":"renew()","type":"codeVoice"},{"type":"text","text":" method of the Authentication API client. This method is not thread-safe, and may end up issuing renewal requests concurrently with the "},{"code":"credentials()","type":"codeVoice"},{"type":"text","text":" method of the Credentials Manager."}]},{"inlineContent":[{"text":"To force a renewal, use the ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","isActive":true},{"text":" method of the Credentials Manager instead. This method is thread-safe; the Credentials Manager will make sure only one renewal request is in flight at any given time.","type":"text"}],"type":"paragraph"},{"type":"heading","text":"Using the Authentication API client to renew the credentials without synchronization","anchor":"Using-the-Authentication-API-client-to-renew-the-credentials-without-synchronization","level":4},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you are "},{"type":"emphasis","inlineContent":[{"text":"not","type":"text"}]},{"text":" using the Credentials Manager, you need to implement proper synchronization to call the ","type":"text"},{"type":"codeVoice","code":"renew()"},{"text":" method of the Authentication API client. This method is not thread-safe; unless care is taken, concurrent renewal requests can happen.","type":"text"}]}],"kind":"content"}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/refreshtokens"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")","kind":"text"}],"type":"topic","role":"symbol","title":"renew(parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"inlineContent":[{"text":"This method is thread-safe","type":"text"}],"type":"strong"},{"text":".","type":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/secure/tokens/refresh-tokens/refresh-token-rotation":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","type":"link","titleInlineContent":[{"text":"Refresh Token Rotation","type":"text"}],"title":"Refresh Token Rotation"},"https://auth0.com/docs/secure/tokens/refresh-tokens/configure-refresh-token-rotation":{"title":"reuse interval","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-rotation","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-rotation","titleInlineContent":[{"type":"text","text":"reuse interval"}]},"https://auth0.com/docs/secure/tokens/refresh-tokens/configure-refresh-token-expiration":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","type":"link","titleInlineContent":[{"text":"absolute lifetime","type":"text"}],"title":"absolute lifetime"}}} \ No newline at end of file +{"kind":"article","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/refreshtokens"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"},"primaryContentSections":[{"kind":"content","content":[{"text":"Overview","anchor":"Overview","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"Exchanging a refresh token for new credentials can produce the following errors, depending on the implementation of your app, and the configuration of your Auth0 application.","type":"text"}]},{"level":2,"text":"Unknown or invalid refresh token","type":"heading","anchor":"Unknown-or-invalid-refresh-token"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"text":"Example error description:","type":"text"}],"type":"strong"},{"type":"text","text":" "},{"type":"codeVoice","code":"The credentials renewal failed. CAUSE: Unknown or invalid refresh token"}]}]},{"content":[{"inlineContent":[{"inlineContent":[{"type":"text","text":"Log event type:"}],"type":"strong"},{"type":"text","text":" "},{"type":"codeVoice","code":"fertft"}],"type":"paragraph"}]}]},{"inlineContent":[{"text":"This error means that Auth0 does not recognize the refresh token used to make the renewal request. Either an empty or garbage\/truncated\/padded token was sent, or the token is not valid anymore –it expired or was revoked.","type":"text"}],"type":"paragraph"},{"anchor":"Common-causes","type":"heading","level":3,"text":"Common causes"},{"anchor":"Renewing-the-credentials-after-revoking-the-refresh-token","level":4,"text":"Renewing the credentials after revoking the refresh token","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you revoke the refresh token –either through the Credentials Manager or the Authentication API client– you should not attempt to renew the credentials afterward. For example, by calling the "},{"code":"credentials()","type":"codeVoice"},{"type":"text","text":" method of the Credentials Manager in another thread."}]},{"inlineContent":[{"text":"Once a refresh token is revoked it can no longer be exchanged for new credentials.","type":"text"}],"type":"paragraph"},{"level":4,"anchor":"Misconfiguration-of-the-absolute-lifetime-of-refresh-tokens","type":"heading","text":"Misconfiguration of the absolute lifetime of refresh tokens"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","isActive":true,"type":"reference"},{"text":" of the refresh token should not be shorter than the lifetime of the access token. If the access token is valid for longer than the refresh token is, your app may issue renewal requests with expired refresh tokens. This could happen, for example, when using the ","type":"text"},{"code":"credentials()","type":"codeVoice"},{"text":" method of the Credentials Manager.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"Once a refresh token expires it can no longer be exchanged for new credentials.","type":"text"}]},{"level":4,"text":"Misconfiguration of the inactivity lifetime of refresh tokens","anchor":"Misconfiguration-of-the-inactivity-lifetime-of-refresh-tokens","type":"heading"},{"inlineContent":[{"type":"text","text":"The "},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","isActive":true,"overridingTitle":"inactivity lifetime","type":"reference","overridingTitleInlineContent":[{"type":"text","text":"inactivity lifetime"}]},{"type":"text","text":" of the refresh token should not be shorter than the lifetime of the access token. If the access token is valid for longer than the refresh token is "},{"type":"emphasis","inlineContent":[{"text":"while the user is inactive","type":"text"}]},{"type":"text","text":", your app may issue renewal requests with expired refresh tokens. This could happen, for example, when using the "},{"type":"codeVoice","code":"credentials()"},{"text":" method of the Credentials Manager while your app is backgrounded.","type":"text"}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"text":"Once a refresh token expires due to user inactivity it can no longer be exchanged for new credentials.","type":"text"}]},{"anchor":"Unsuccessful-Refresh-Token-exchange-reused-refresh-token-detected","text":"Unsuccessful Refresh Token exchange, reused refresh token detected","level":2,"type":"heading"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"text":"Example error description:","type":"text"}]},{"text":" ","type":"text"},{"type":"codeVoice","code":"The credentials renewal failed. CAUSE: Unsuccessful Refresh Token exchange, reused refresh token detected"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"Log event type:"}],"type":"strong"},{"type":"text","text":" "},{"type":"codeVoice","code":"ferrt"}]}]}],"type":"unorderedList"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You might encounter this error if you have "},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","isActive":true,"type":"reference"},{"type":"text","text":" enabled for your Auth0 application. It means that the refresh token used to make the renewal request has already been exchanged, and the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-rotation","isActive":true},{"text":" has passed.","type":"text"}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Rotating refresh tokens are effectively single-use. The renewed credentials will come with a new refresh token, and the old one will be invalidated once the renew interval passes."}]},{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"text":"In the absence of a bad actor, this error is typically a symptom of concurrency issues in your app.","type":"text"}]}]},{"level":3,"anchor":"Common-causes","text":"Common causes","type":"heading"},{"type":"heading","anchor":"Multiple-Credentials-Manager-instances","text":"Multiple Credentials Manager instances","level":4},{"inlineContent":[{"type":"text","text":"If you are using the Credentials Manager to renew the credentials -either through the "},{"type":"codeVoice","code":"credentials()"},{"type":"text","text":" or the "},{"type":"codeVoice","code":"renew()"},{"text":" method- you should use a single Credentials Manager instance. While these methods are thread-safe, the Credentials Manager cannot synchronize them across instances.","type":"text"}],"type":"paragraph"},{"type":"paragraph","inlineContent":[{"text":"This can happen, for example, by using a computed property to get a Credentials Manager instance:","type":"text"}]},{"syntax":null,"code":["struct Services {"," \/\/ ❌ This will return a new instance every time"," var credentialsManager: CredentialsManager {"," return CredentialsManager(authentication: Auth0.authentication())"," }","}"],"type":"codeListing"},{"type":"heading","level":4,"text":"Using the Authentication API client to renew the credentials alongside the Credentials Manager","anchor":"Using-the-Authentication-API-client-to-renew-the-credentials-alongside-the-Credentials-Manager"},{"type":"paragraph","inlineContent":[{"text":"If you are using the Credentials Manager to store and retrieve the credentials, you should not force renewals through the ","type":"text"},{"type":"codeVoice","code":"renew()"},{"type":"text","text":" method of the Authentication API client. This method is not thread-safe, and may end up issuing renewal requests concurrently with the "},{"type":"codeVoice","code":"credentials()"},{"text":" method of the Credentials Manager.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"To force a renewal, use the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)"},{"type":"text","text":" method of the Credentials Manager instead. This method is thread-safe; the Credentials Manager will make sure only one renewal request is in flight at any given time."}]},{"text":"Using the Authentication API client to renew the credentials without synchronization","type":"heading","anchor":"Using-the-Authentication-API-client-to-renew-the-credentials-without-synchronization","level":4},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you are "},{"type":"emphasis","inlineContent":[{"text":"not","type":"text"}]},{"text":" using the Credentials Manager, you need to implement proper synchronization to call the ","type":"text"},{"code":"renew()","type":"codeVoice"},{"text":" method of the Authentication API client. This method is not thread-safe; unless care is taken, concurrent renewal requests can happen.","type":"text"}]}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"role":"article","modules":[{"name":"Auth0"}],"title":"Refresh Tokens: Common Errors","roleHeading":"Article"},"references":{"https://auth0.com/docs/secure/tokens/refresh-tokens/refresh-token-rotation":{"titleInlineContent":[{"type":"text","text":"Refresh Token Rotation"}],"title":"Refresh Token Rotation","type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":")"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","title":"renew(parameters:headers:callback:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}]},"https://auth0.com/docs/secure/tokens/refresh-tokens/configure-refresh-token-expiration":{"titleInlineContent":[{"text":"absolute lifetime","type":"text"}],"title":"absolute lifetime","type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration"},"https://auth0.com/docs/secure/tokens/refresh-tokens/configure-refresh-token-rotation":{"title":"reuse interval","type":"link","titleInlineContent":[{"type":"text","text":"reuse interval"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-rotation","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-rotation"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/request.json b/docs/data/documentation/auth0/request.json index 40fde76e..5978aea5 100644 --- a/docs/data/documentation/auth0/request.json +++ b/docs/data/documentation/auth0/request.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)"]},{"title":"Type Aliases","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"]}],"abstract":[{"type":"text","text":"Auth0 API request."}],"sections":[],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/request"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth07RequestV","title":"Request","navigatorTitle":[{"text":"Request","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Request","kind":"identifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"struct","roleHeading":"Structure"},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"Request","kind":"identifier"},{"text":"<","kind":"text"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":", "},{"kind":"genericParameter","text":"E"},{"kind":"text","text":"> "},{"kind":"keyword","text":"where"},{"text":" ","kind":"text"},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:5Auth00A8APIErrorP","kind":"typeIdentifier","text":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"syntax":"swift","type":"codeListing","code":["let request: Request = \/\/ ...","","request.start { result in"," print(result)","}"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/headers(_:)":{"type":"topic","abstract":[{"type":"text","text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones."}],"title":"headers(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"headers"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/request\/headers(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-8gjgk":{"kind":"symbol","role":"symbol","conformance":{"conformancePrefix":[{"text":"Conforms when","type":"text"}],"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}],"availabilityPrefix":[{"text":"Available when","type":"text"}]},"url":"\/documentation\/auth0\/request\/start()-8gjgk","type":"topic","abstract":[{"type":"text","text":"Performs the request."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp"}],"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/start(_:)":{"abstract":[{"text":"Performs the request.","type":"text"}],"url":"\/documentation\/auth0\/request\/start(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","type":"topic","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Callback","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV8Callbacka"},{"kind":"text","text":")"}],"title":"start(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/Request/parameters(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","abstract":[{"type":"text","text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones."}],"title":"parameters(_:)","kind":"symbol","url":"\/documentation\/auth0\/request\/parameters(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"text":">","kind":"text"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","title":"Request.Callback","url":"\/documentation\/auth0\/request\/callback","abstract":[{"type":"text","text":"The callback closure type for the request."}],"role":"symbol","type":"topic","navigatorTitle":[{"text":"Callback","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Callback","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-132e1":{"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","text":"E"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"code":"E","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}]},"url":"\/documentation\/auth0\/request\/start()-132e1","abstract":[{"text":"Combine publisher for the request.","type":"text"}],"type":"topic","title":"start()"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth07RequestV","modules":[{"name":"Auth0"}],"symbolKind":"struct","roleHeading":"Structure","title":"Request","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},"abstract":[{"type":"text","text":"Auth0 API request."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Request","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"kind":"text","text":", "},{"text":"E","kind":"genericParameter"},{"text":"> ","kind":"text"},{"kind":"keyword","text":"where"},{"kind":"text","text":" "},{"text":"E","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Auth0APIError","preciseIdentifier":"s:5Auth00A8APIErrorP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"type":"codeListing","code":["let request: Request = \/\/ ...","","request.start { result in"," print(result)","}"],"syntax":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/request"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"],"title":"Type Aliases"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/start(_:)":{"abstract":[{"text":"Performs the request.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol","title":"start(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"("},{"text":"Callback","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV8Callbacka"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/request\/start(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"abstract":[{"text":"The callback closure type for the request.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol","title":"Request.Callback","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"}],"url":"\/documentation\/auth0\/request\/callback","navigatorTitle":[{"kind":"identifier","text":"Callback"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"},"doc://com.auth0.Auth0/documentation/Auth0/Request/parameters(_:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"kind":"text","text":"(["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"text":">","kind":"text"}],"type":"topic","title":"parameters(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","kind":"symbol","url":"\/documentation\/auth0\/request\/parameters(_:)","abstract":[{"type":"text","text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones."}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-132e1":{"url":"\/documentation\/auth0\/request\/start()-132e1","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","type":"topic","title":"start()","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"code":"Auth0APIError","type":"codeVoice"},{"text":".","type":"text"}]},"abstract":[{"type":"text","text":"Combine publisher for the request."}],"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"() -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"E","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-8gjgk":{"title":"start()","url":"\/documentation\/auth0\/request\/start()-8gjgk","abstract":[{"text":"Performs the request.","type":"text"}],"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","role":"symbol","kind":"symbol","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"text":".","type":"text"}]}},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"title":"Auth0APIError","url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request/headers(_:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"headers"},{"kind":"text","text":"(["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"kind":"text","text":">"}],"type":"topic","title":"headers(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","url":"\/documentation\/auth0\/request\/headers(_:)","kind":"symbol","abstract":[{"text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones.","type":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/request/callback.json b/docs/data/documentation/auth0/request/callback.json index 2289a149..9d7f25c1 100644 --- a/docs/data/documentation/auth0/request/callback.json +++ b/docs/data/documentation/auth0/request/callback.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/callback"]}],"metadata":{"navigatorTitle":[{"text":"Callback","kind":"identifier"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth07RequestV8Callbacka","title":"Request.Callback","roleHeading":"Type Alias","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Callback","kind":"identifier"}],"symbolKind":"typealias"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","interfaceLanguage":"swift"},"abstract":[{"text":"The callback closure type for the request.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Callback"},{"text":" = (","kind":"text"},{"preciseIdentifier":"s:s6ResultO","text":"Result","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"kind":"text","text":">) -> "},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","title":"Request.Callback","url":"\/documentation\/auth0\/request\/callback","abstract":[{"type":"text","text":"The callback closure type for the request."}],"role":"symbol","type":"topic","navigatorTitle":[{"text":"Callback","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Callback","kind":"identifier"}]}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/request\/callback"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"roleHeading":"Type Alias","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Callback","kind":"identifier"}],"externalID":"s:5Auth07RequestV8Callbacka","symbolKind":"typealias","modules":[{"name":"Auth0"}],"title":"Request.Callback","navigatorTitle":[{"kind":"identifier","text":"Callback"}],"role":"symbol"},"abstract":[{"text":"The callback closure type for the request.","type":"text"}],"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Callback"},{"text":" = (","kind":"text"},{"kind":"typeIdentifier","text":"Result","preciseIdentifier":"s:s6ResultO"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier","text":"T"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"abstract":[{"text":"The callback closure type for the request.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol","title":"Request.Callback","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"}],"url":"\/documentation\/auth0\/request\/callback","navigatorTitle":[{"kind":"identifier","text":"Callback"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/request/headers(_:).json b/docs/data/documentation/auth0/request/headers(_:).json index d183a405..63bd0e1b 100644 --- a/docs/data/documentation/auth0/request/headers(_:).json +++ b/docs/data/documentation/auth0/request/headers(_:).json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"abstract":[{"text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones.","type":"text"}],"metadata":{"externalID":"s:5Auth07RequestV7headersyACyxq_GSDyS2SGF","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"headers","kind":"identifier"},{"kind":"text","text":"(["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"headers(_:)","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"extraHeaders","kind":"internalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"parameters":[{"name":"extraHeaders","content":[{"inlineContent":[{"type":"text","text":"Additional headers for the request."}],"type":"paragraph"}]}],"kind":"parameters"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/headers(_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/headers(_:)":{"type":"topic","abstract":[{"type":"text","text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones."}],"title":"headers(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"headers"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/request\/headers(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"headers"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"extraHeaders"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"extraHeaders","content":[{"inlineContent":[{"type":"text","text":"Additional headers for the request."}],"type":"paragraph"}]}],"kind":"parameters"}],"variants":[{"paths":["\/documentation\/auth0\/request\/headers(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"headers(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"text":">","kind":"text"}],"symbolKind":"method","externalID":"s:5Auth07RequestV7headersyACyxq_GSDyS2SGF","roleHeading":"Instance Method","role":"symbol","modules":[{"name":"Auth0"}]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/headers(_:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"headers"},{"kind":"text","text":"(["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"kind":"text","text":">"}],"type":"topic","title":"headers(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","url":"\/documentation\/auth0\/request\/headers(_:)","kind":"symbol","abstract":[{"text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/request/parameters(_:).json b/docs/data/documentation/auth0/request/parameters(_:).json index 977d7e98..7c69872b 100644 --- a/docs/data/documentation/auth0/request/parameters(_:).json +++ b/docs/data/documentation/auth0/request/parameters(_:).json @@ -1 +1 @@ -{"abstract":[{"text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones.","type":"text"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"metadata":{"externalID":"s:5Auth07RequestV10parametersyACyxq_GSDySSypGF","roleHeading":"Instance Method","title":"parameters(_:)","modules":[{"name":"Auth0"}],"symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"parameters","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/request\/parameters(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"extraParameters","kind":"internalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"extraParameters","content":[{"type":"paragraph","inlineContent":[{"text":"Additional parameters for the request.","type":"text"}]}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/parameters(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","abstract":[{"type":"text","text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones."}],"title":"parameters(_:)","kind":"symbol","url":"\/documentation\/auth0\/request\/parameters(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"text":">","kind":"text"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"extraParameters","kind":"internalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"T"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"languages":["swift"]}]},{"parameters":[{"name":"extraParameters","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters for the request."}]}]}],"kind":"parameters"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"variants":[{"paths":["\/documentation\/auth0\/request\/parameters(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones."}],"metadata":{"role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth07RequestV10parametersyACyxq_GSDySSypGF","title":"parameters(_:)","symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)"},"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request/parameters(_:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"kind":"text","text":"(["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"text":">","kind":"text"}],"type":"topic","title":"parameters(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","kind":"symbol","url":"\/documentation\/auth0\/request\/parameters(_:)","abstract":[{"type":"text","text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones."}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/request/start()-132e1.json b/docs/data/documentation/auth0/request/start()-132e1.json index 389dafe1..a09525f8 100644 --- a/docs/data/documentation/auth0/request/start()-132e1.json +++ b/docs/data/documentation/auth0/request/start()-132e1.json @@ -1 +1 @@ -{"metadata":{"title":"start()","extendedModule":"Auth0","role":"symbol","symbolKind":"method","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}]},"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"E","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth07RequestV5start7Combine12AnyPublisherVyxq_GyF"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/start()-132e1"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","text":"E"},{"text":">","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"A type-erased publisher.","type":"text"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"abstract":[{"type":"text","text":"Combine publisher for the request."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-132e1":{"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","text":"E"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"code":"E","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}]},"url":"\/documentation\/auth0\/request\/start()-132e1","abstract":[{"text":"Combine publisher for the request.","type":"text"}],"type":"topic","title":"start()"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"kind":"text","text":">"}],"title":"start()","modules":[{"name":"Auth0"}],"conformance":{"constraints":[{"type":"codeVoice","code":"E"},{"text":" conforms to ","type":"text"},{"code":"Auth0APIError","type":"codeVoice"},{"text":".","type":"text"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}]},"extendedModule":"Auth0","symbolKind":"method","role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth07RequestV5start7Combine12AnyPublisherVyxq_GyF"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/start()-132e1"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp"},{"kind":"text","text":", "},{"text":"E","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"A type-erased publisher.","type":"text"}]}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Combine publisher for the request."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-132e1":{"url":"\/documentation\/auth0\/request\/start()-132e1","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","type":"topic","title":"start()","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"code":"Auth0APIError","type":"codeVoice"},{"text":".","type":"text"}]},"abstract":[{"type":"text","text":"Combine publisher for the request."}],"role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"() -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"E","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"kind":"text","text":">"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/request/start()-8gjgk.json b/docs/data/documentation/auth0/request/start()-8gjgk.json index 03f54b09..0aee9d7c 100644 --- a/docs/data/documentation/auth0/request/start()-8gjgk.json +++ b/docs/data/documentation/auth0/request/start()-8gjgk.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk"},"variants":[{"paths":["\/documentation\/auth0\/request\/start()-8gjgk"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T","kind":"typeIdentifier"}]}],"kind":"declarations"},{"content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"type":"aside","content":[{"inlineContent":[{"text":"An error that conforms to ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","isActive":true,"type":"reference"},{"type":"text","text":"; either an "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true},{"type":"text","text":" or a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Throws","style":"note"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"conformance":{"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"text":".","type":"text"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}]},"title":"start()","symbolKind":"method","role":"symbol","extendedModule":"Auth0","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp"}],"externalID":"s:5Auth07RequestV5startxyYaKF"},"abstract":[{"type":"text","text":"Performs the request."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-8gjgk":{"kind":"symbol","role":"symbol","conformance":{"conformancePrefix":[{"text":"Conforms when","type":"text"}],"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}],"availabilityPrefix":[{"text":"Available when","type":"text"}]},"url":"\/documentation\/auth0\/request\/start()-8gjgk","type":"topic","abstract":[{"type":"text","text":"Performs the request."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp"}],"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"title":"AuthenticationError","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AuthenticationError","kind":"identifier"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror"}}} \ No newline at end of file +{"metadata":{"title":"start()","extendedModule":"Auth0","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"() ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier","text":"T"}],"role":"symbol","externalID":"s:5Auth07RequestV5startxyYaKF","roleHeading":"Instance Method","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}],"constraints":[{"code":"E","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Auth0APIError","type":"codeVoice"},{"type":"text","text":"."}]},"modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/request\/start()-8gjgk"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp"}]}]},{"content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"type":"aside","style":"note","content":[{"inlineContent":[{"text":"An error that conforms to ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"},{"type":"text","text":"; either an "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference","isActive":true},{"type":"text","text":" or a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Throws"}],"kind":"content"}],"abstract":[{"type":"text","text":"Performs the request."}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"title":"Auth0APIError","url":"\/documentation\/auth0\/auth0apierror","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-8gjgk":{"title":"start()","url":"\/documentation\/auth0\/request\/start()-8gjgk","abstract":[{"text":"Performs the request.","type":"text"}],"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","role":"symbol","kind":"symbol","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"text":".","type":"text"}]}},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","title":"AuthenticationError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"url":"\/documentation\/auth0\/authenticationerror","role":"symbol","type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/request/start(_:).json b/docs/data/documentation/auth0/request/start(_:).json index ee730ada..faaeade2 100644 --- a/docs/data/documentation/auth0/request/start(_:).json +++ b/docs/data/documentation/auth0/request/start(_:).json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Performs the request."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" ","kind":"text"},{"kind":"typeIdentifier","text":"Callback","preciseIdentifier":"s:5Auth07RequestV8Callbacka","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"callback","content":[{"inlineContent":[{"text":"Callback that receives the result of the request when it completes.","type":"text"}],"type":"paragraph"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/request\/start(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"metadata":{"symbolKind":"method","role":"symbol","title":"start(_:)","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth07RequestV8Callbacka","kind":"typeIdentifier","text":"Callback"},{"kind":"text","text":")"}],"externalID":"s:5Auth07RequestV5startyyys6ResultOyxq_GcF"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","title":"Request.Callback","url":"\/documentation\/auth0\/request\/callback","abstract":[{"type":"text","text":"The callback closure type for the request."}],"role":"symbol","type":"topic","navigatorTitle":[{"text":"Callback","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Callback","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/start(_:)":{"abstract":[{"text":"Performs the request.","type":"text"}],"url":"\/documentation\/auth0\/request\/start(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","type":"topic","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Callback","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV8Callbacka"},{"kind":"text","text":")"}],"title":"start(_:)"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/start(_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"metadata":{"externalID":"s:5Auth07RequestV5startyyys6ResultOyxq_GcF","symbolKind":"method","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV8Callbacka","text":"Callback"},{"text":")","kind":"text"}],"title":"start(_:)","modules":[{"name":"Auth0"}],"role":"symbol"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","text":"Callback","preciseIdentifier":"s:5Auth07RequestV8Callbacka","kind":"typeIdentifier"},{"kind":"text","text":")"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"callback","content":[{"inlineContent":[{"text":"Callback that receives the result of the request when it completes.","type":"text"}],"type":"paragraph"}]}]}],"kind":"symbol","abstract":[{"text":"Performs the request.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/start(_:)":{"abstract":[{"text":"Performs the request.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol","title":"start(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"("},{"text":"Callback","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV8Callbacka"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/request\/start(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"abstract":[{"text":"The callback closure type for the request.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol","title":"Request.Callback","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"}],"url":"\/documentation\/auth0\/request\/callback","navigatorTitle":[{"kind":"identifier","text":"Callback"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/simplekeychain.json b/docs/data/documentation/auth0/simplekeychain.json index 64f902fe..1e6298cb 100644 --- a/docs/data/documentation/auth0/simplekeychain.json +++ b/docs/data/documentation/auth0/simplekeychain.json @@ -1 +1 @@ -{"topicSections":[{"title":"Extended Structures","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain"]}],"metadata":{"symbolKind":"extension","modules":[{"name":"Auth0"}],"roleHeading":"Extended Module","title":"SimpleKeychain","externalID":"s:m:s:e:s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","role":"collection"},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","role":"collection","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"url":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","navigatorTitle":[{"text":"SimpleKeychain","kind":"identifier"}],"title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},{"text":".","type":"text"}]}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"role":"collection","symbolKind":"extension","externalID":"s:m:s:e:s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","modules":[{"name":"Auth0"}],"title":"SimpleKeychain","roleHeading":"Extended Module"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"],"title":"Extended Structures"}],"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/simplekeychain"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[{"type":"text","text":"Conformance to "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","title":"CredentialsStorage"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/simplekeychain/simplekeychain.json b/docs/data/documentation/auth0/simplekeychain/simplekeychain.json index 588331f7..56cfa71b 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain.json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain.json @@ -1 +1 @@ -{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"],"title":"Default Implementations","generated":true}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"]]},"metadata":{"extendedModule":"SimpleKeychain","symbolKind":"extension","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV"}],"title":"SimpleKeychain","modules":[{"relatedModules":["SimpleKeychain"],"name":"Auth0"}],"role":"symbol","roleHeading":"Extended Structure","navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"externalID":"s:e:s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"typeIdentifier","preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"title":"Conforms To","kind":"relationships","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Conformance to "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true,"type":"reference"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","navigatorTitle":[{"text":"SimpleKeychain","kind":"identifier"}],"title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"abstract":[],"title":"CredentialsStorage Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","kind":"article","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","type":"topic","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","role":"collection","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"url":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}]}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"],"type":"conformsTo"}],"topicSections":[{"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"],"generated":true}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}],"roleHeading":"Extended Structure","extendedModule":"SimpleKeychain","title":"SimpleKeychain","role":"symbol","symbolKind":"extension","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain","kind":"identifier"}],"externalID":"s:e:s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"text":"SimpleKeychain","kind":"typeIdentifier","preciseIdentifier":"s:14SimpleKeychainAAV"}],"languages":["swift"]}]}],"kind":"symbol","abstract":[{"text":"Conformance to ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[{"type":"text","text":"Conformance to "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","title":"CredentialsStorage"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","title":"CredentialsStorage Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","abstract":[],"role":"collectionGroup","type":"topic","kind":"article"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/simplekeychain/simplekeychain/credentialsstorage-implementations.json b/docs/data/documentation/auth0/simplekeychain/simplekeychain/credentialsstorage-implementations.json index 0f62f306..86d85a36 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain/credentialsstorage-implementations.json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain/credentialsstorage-implementations.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"title":"CredentialsStorage Implementations","roleHeading":"API Collection","role":"collectionGroup"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","interfaceLanguage":"swift"},"kind":"article","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)"],"generated":true}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"url":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/setEntry(_:forKey:)":{"abstract":[{"text":"Sets a storage entry.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","kind":"symbol","title":"setEntry(_:forKey:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":", "},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","role":"collection","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","navigatorTitle":[{"text":"SimpleKeychain","kind":"identifier"}],"title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/getEntry(forKey:)":{"type":"topic","title":"getEntry(forKey:)","kind":"symbol","abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/deleteEntry(forKey:)":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","role":"symbol","title":"deleteEntry(forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","text":"("},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[{"text":"Deletes a storage entry.","type":"text"}]}}} \ No newline at end of file +{"kind":"article","variants":[{"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"},"topicSections":[{"generated":true,"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)"]}],"sections":[],"metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"CredentialsStorage Implementations"},"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","title":"CredentialsStorage"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/setEntry(_:forKey:)":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","kind":"symbol","title":"setEntry(_:forKey:)","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","abstract":[{"text":"Sets a storage entry.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"setEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/getEntry(forKey:)":{"role":"symbol","title":"getEntry(forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","type":"topic","abstract":[{"type":"text","text":"Retrieves a storage entry."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"kind":"text","text":"?"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[{"type":"text","text":"Conformance to "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/deleteEntry(forKey:)":{"role":"symbol","title":"deleteEntry(forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","type":"topic","abstract":[{"type":"text","text":"Deletes a storage entry."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/simplekeychain/simplekeychain/deleteentry(forkey:).json b/docs/data/documentation/auth0/simplekeychain/simplekeychain/deleteentry(forkey:).json index f159ed47..b91e9f49 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain/deleteentry(forkey:).json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain/deleteentry(forkey:).json @@ -1 +1 @@ -{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","text":"("},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]}]},{"parameters":[{"name":"key","content":[{"inlineContent":[{"text":"The key to delete from the Keychain.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"If the data was deleted.","type":"text"}]}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)"]}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"deleteEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"roleHeading":"Instance Method","extendedModule":"SimpleKeychain","symbolKind":"method","externalID":"s:14SimpleKeychainAAV5Auth0E11deleteEntry6forKeySbSS_tF","role":"symbol","modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}],"title":"deleteEntry(forKey:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"]]},"abstract":[{"type":"text","text":"Deletes a storage entry."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"abstract":[],"title":"CredentialsStorage Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","kind":"article","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","type":"topic","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","role":"collection","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"url":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","navigatorTitle":[{"text":"SimpleKeychain","kind":"identifier"}],"title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/deleteEntry(forKey:)":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","role":"symbol","title":"deleteEntry(forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","text":"("},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[{"text":"Deletes a storage entry.","type":"text"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"]]},"abstract":[{"type":"text","text":"Deletes a storage entry."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The key to delete from the Keychain.","type":"text"}]}],"name":"key"}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"If the data was deleted.","type":"text"}]}]}],"sections":[],"metadata":{"title":"deleteEntry(forKey:)","symbolKind":"method","extendedModule":"SimpleKeychain","externalID":"s:14SimpleKeychainAAV5Auth0E11deleteEntry6forKeySbSS_tF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"roleHeading":"Instance Method","modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}],"role":"symbol"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","title":"CredentialsStorage"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/deleteEntry(forKey:)":{"role":"symbol","title":"deleteEntry(forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","type":"topic","abstract":[{"type":"text","text":"Deletes a storage entry."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[{"type":"text","text":"Conformance to "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","title":"CredentialsStorage Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","abstract":[],"role":"collectionGroup","type":"topic","kind":"article"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/simplekeychain/simplekeychain/getentry(forkey:).json b/docs/data/documentation/auth0/simplekeychain/simplekeychain/getentry(forkey:).json index b3d6f8d4..ddb699cc 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain/getentry(forkey:).json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain/getentry(forkey:).json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"metadata":{"role":"symbol","title":"getEntry(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"roleHeading":"Instance Method","extendedModule":"SimpleKeychain","symbolKind":"method","modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}],"externalID":"s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF"},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"kind":"text","text":"("},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":" "},{"text":"key","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The key to get from the Keychain.","type":"text"}]}],"name":"key"}]},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The stored data."}]}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"]]},"abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"url":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","navigatorTitle":[{"text":"SimpleKeychain","kind":"identifier"}],"title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/getEntry(forKey:)":{"type":"topic","title":"getEntry(forKey:)","kind":"symbol","abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"abstract":[],"title":"CredentialsStorage Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","kind":"article","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","type":"topic","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","role":"collection","type":"topic"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"text":"key","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"text":"?","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The key to get from the Keychain."}],"type":"paragraph"}],"name":"key"}]},{"content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"The stored data."}]}],"kind":"content"}],"metadata":{"externalID":"s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","symbolKind":"method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEntry"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"text":"?","kind":"text"}],"roleHeading":"Instance Method","extendedModule":"SimpleKeychain","title":"getEntry(forKey:)","modules":[{"relatedModules":["SimpleKeychain"],"name":"Auth0"}]},"variants":[{"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"]]},"abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","title":"CredentialsStorage"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[{"type":"text","text":"Conformance to "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","title":"CredentialsStorage Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","abstract":[],"role":"collectionGroup","type":"topic","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/getEntry(forKey:)":{"role":"symbol","title":"getEntry(forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","type":"topic","abstract":[{"type":"text","text":"Retrieves a storage entry."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"kind":"text","text":"?"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/simplekeychain/simplekeychain/setentry(_:forkey:).json b/docs/data/documentation/auth0/simplekeychain/simplekeychain/setentry(_:forkey:).json index d60fd0fe..7030f2b7 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain/setentry(_:forkey:).json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain/setentry(_:forkey:).json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}],"extendedModule":"SimpleKeychain","roleHeading":"Instance Method","symbolKind":"method","externalID":"s:14SimpleKeychainAAV5Auth0E8setEntry_6forKeySb10Foundation4DataV_SStF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"setEntry(_:forKey:)","role":"symbol"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"setEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"data","kind":"internalParam"},{"kind":"text","text":": "},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"forKey"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"data","content":[{"type":"paragraph","inlineContent":[{"text":"The data to be stored.","type":"text"}]}]},{"name":"key","content":[{"inlineContent":[{"text":"The key to store it to.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"inlineContent":[{"text":"If the data was stored.","type":"text"}],"type":"paragraph"}]}],"variants":[{"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"]]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Sets a storage entry."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","navigatorTitle":[{"text":"SimpleKeychain","kind":"identifier"}],"title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","role":"collection","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"url":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"abstract":[],"title":"CredentialsStorage Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","kind":"article","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","type":"topic","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/setEntry(_:forKey:)":{"abstract":[{"text":"Sets a storage entry.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","kind":"symbol","title":"setEntry(_:forKey:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":", "},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","role":"symbol"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"data","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"forKey","kind":"externalParam"},{"kind":"text","text":" "},{"text":"key","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"languages":["swift"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The data to be stored.","type":"text"}]}],"name":"data"},{"name":"key","content":[{"type":"paragraph","inlineContent":[{"text":"The key to store it to.","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"type":"text","text":"If the data was stored."}],"type":"paragraph"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"]]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}],"title":"setEntry(_:forKey:)","extendedModule":"SimpleKeychain","role":"symbol","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"setEntry","kind":"identifier"},{"kind":"text","text":"("},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"externalID":"s:14SimpleKeychainAAV5Auth0E8setEntry_6forKeySb10Foundation4DataV_SStF","symbolKind":"method"},"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)"]}],"abstract":[{"text":"Sets a storage entry.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[],"url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"type":"text","text":"Generic storage API for storing credentials."}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"symbol","title":"CredentialsStorage"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"kind":"symbol","title":"SimpleKeychain","abstract":[{"type":"text","text":"Conformance to "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/setEntry(_:forKey:)":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","kind":"symbol","title":"setEntry(_:forKey:)","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","abstract":[{"text":"Sets a storage entry.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"setEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","title":"CredentialsStorage Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","abstract":[],"role":"collectionGroup","type":"topic","kind":"article"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/swift.json b/docs/data/documentation/auth0/swift.json index 288b559a..19b63ac9 100644 --- a/docs/data/documentation/auth0/swift.json +++ b/docs/data/documentation/auth0/swift.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:m:s:e:s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","modules":[{"name":"Auth0"}],"role":"collection","roleHeading":"Extended Module","symbolKind":"extension","title":"Swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/swift"]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"],"title":"Extended Structures"}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","abstract":[],"url":"\/documentation\/auth0\/swift","title":"Swift","role":"collection","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"url":"\/documentation\/auth0\/swift\/string","abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","type":"topic","kind":"symbol","navigatorTitle":[{"text":"String","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"String","preciseIdentifier":"s:SS"}],"title":"String","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"],"title":"Extended Structures"}],"metadata":{"title":"Swift","externalID":"s:m:s:e:s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","symbolKind":"extension","modules":[{"name":"Auth0"}],"role":"collection","roleHeading":"Extended Module"},"variants":[{"paths":["\/documentation\/auth0\/swift"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"title":"String","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:SS","text":"String"}],"url":"\/documentation\/auth0\/swift\/string","abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"navigatorTitle":[{"kind":"identifier","text":"String"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"url":"\/documentation\/auth0\/swift","title":"Swift","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","abstract":[],"role":"collection","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/swift/string.json b/docs/data/documentation/auth0/swift/string.json index 094ac018..7ebea1f5 100644 --- a/docs/data/documentation/auth0/swift/string.json +++ b/docs/data/documentation/auth0/swift/string.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/swift\/string"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()"],"title":"Instance Methods"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"metadata":{"extendedModule":"Swift","role":"symbol","externalID":"s:e:s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","symbolKind":"extension","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"String","preciseIdentifier":"s:SS"}],"navigatorTitle":[{"kind":"identifier","text":"String"}],"modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"title":"String","roleHeading":"Extended Structure"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","abstract":[],"url":"\/documentation\/auth0\/swift","title":"Swift","role":"collection","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"url":"\/documentation\/auth0\/swift\/string","abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","type":"topic","kind":"symbol","navigatorTitle":[{"text":"String","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"String","preciseIdentifier":"s:SS"}],"title":"String","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String/a0_decodeBase64URLSafe()":{"abstract":[{"type":"text","text":"Decodes base64url-encoded data."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","kind":"symbol","title":"a0_decodeBase64URLSafe()"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"title":"String","roleHeading":"Extended Structure","symbolKind":"extension","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"identifier"}],"modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"extendedModule":"Swift","externalID":"s:e:s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"String"}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/swift\/string"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Adds a utility method for decoding base64url-encoded data, like ID tokens.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift/String/a0_decodeBase64URLSafe()":{"title":"a0_decodeBase64URLSafe()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","abstract":[{"type":"text","text":"Decodes base64url-encoded data."}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"title":"String","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:SS","text":"String"}],"url":"\/documentation\/auth0\/swift\/string","abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"navigatorTitle":[{"kind":"identifier","text":"String"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"url":"\/documentation\/auth0\/swift","title":"Swift","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","abstract":[],"role":"collection","type":"topic","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/swift/string/a0_decodebase64urlsafe().json b/docs/data/documentation/auth0/swift/string/a0_decodebase64urlsafe().json index 5e15882a..3b77f651 100644 --- a/docs/data/documentation/auth0/swift/string/a0_decodebase64urlsafe().json +++ b/docs/data/documentation/auth0/swift/string/a0_decodebase64urlsafe().json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()"},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Decodes base64url-encoded data."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"]]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"a0_decodeBase64URLSafe","kind":"identifier"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}]}]}],"metadata":{"role":"symbol","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"a0_decodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}],"symbolKind":"method","title":"a0_decodeBase64URLSafe()","roleHeading":"Instance Method","externalID":"s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","extendedModule":"Swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","abstract":[],"url":"\/documentation\/auth0\/swift","title":"Swift","role":"collection","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"url":"\/documentation\/auth0\/swift\/string","abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","type":"topic","kind":"symbol","navigatorTitle":[{"text":"String","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"String","preciseIdentifier":"s:SS"}],"title":"String","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String/a0_decodeBase64URLSafe()":{"abstract":[{"type":"text","text":"Decodes base64url-encoded data."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","kind":"symbol","title":"a0_decodeBase64URLSafe()"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"]]},"metadata":{"extendedModule":"Swift","externalID":"s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"roleHeading":"Instance Method","role":"symbol","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"text":"?","kind":"text"}],"title":"a0_decodeBase64URLSafe()"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"Decodes base64url-encoded data."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift/String/a0_decodeBase64URLSafe()":{"title":"a0_decodeBase64URLSafe()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","abstract":[{"type":"text","text":"Decodes base64url-encoded data."}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"title":"String","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:SS","text":"String"}],"url":"\/documentation\/auth0\/swift\/string","abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"navigatorTitle":[{"kind":"identifier","text":"String"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"url":"\/documentation\/auth0\/swift","title":"Swift","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","abstract":[],"role":"collection","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/telemetry.json b/docs/data/documentation/auth0/telemetry.json index aa2a4e62..e566ea03 100644 --- a/docs/data/documentation/auth0/telemetry.json +++ b/docs/data/documentation/auth0/telemetry.json @@ -1 +1 @@ -{"metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Telemetry","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"roleHeading":"Structure","title":"Telemetry","role":"symbol","externalID":"s:5Auth09TelemetryV","symbolKind":"struct","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Telemetry","kind":"identifier"}]}]}],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()"]}],"sections":[],"abstract":[{"type":"text","text":"Generates and sets the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/telemetry"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"url":"\/documentation\/auth0\/telemetry","title":"Telemetry","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry/init()":{"fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"()"}],"url":"\/documentation\/auth0\/telemetry\/init()","abstract":[{"type":"text","text":"Initializer that generates a base64url-encoded value with telemetry data."}],"role":"symbol","title":"init()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","type":"topic"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Telemetry","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"roleHeading":"Structure","externalID":"s:5Auth09TelemetryV","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"struct","title":"Telemetry","navigatorTitle":[{"text":"Telemetry","kind":"identifier"}]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/telemetry"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry/init()":{"fragments":[{"text":"init","kind":"identifier"},{"text":"()","kind":"text"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Initializer that generates a base64url-encoded value with telemetry data.","type":"text"}],"url":"\/documentation\/auth0\/telemetry\/init()","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","title":"init()"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","title":"Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"kind":"symbol","url":"\/documentation\/auth0\/telemetry"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/telemetry/init().json b/docs/data/documentation/auth0/telemetry/init().json index ee422b71..aba3ba51 100644 --- a/docs/data/documentation/auth0/telemetry/init().json +++ b/docs/data/documentation/auth0/telemetry/init().json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()"},"kind":"symbol","abstract":[{"type":"text","text":"Initializer that generates a base64url-encoded value with telemetry data."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth09TelemetryVACycfc","roleHeading":"Initializer","symbolKind":"init","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"()","kind":"text"}],"title":"init()","modules":[{"name":"Auth0"}]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"()","kind":"text"}],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"]]},"variants":[{"paths":["\/documentation\/auth0\/telemetry\/init()"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry/init()":{"fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"()"}],"url":"\/documentation\/auth0\/telemetry\/init()","abstract":[{"type":"text","text":"Initializer that generates a base64url-encoded value with telemetry data."}],"role":"symbol","title":"init()","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"url":"\/documentation\/auth0\/telemetry","title":"Telemetry","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"abstract":[{"text":"Initializer that generates a base64url-encoded value with telemetry data.","type":"text"}],"metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"()"}],"title":"init()","roleHeading":"Initializer","modules":[{"name":"Auth0"}],"externalID":"s:5Auth09TelemetryVACycfc","role":"symbol","symbolKind":"init"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"()","kind":"text"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"]]},"variants":[{"paths":["\/documentation\/auth0\/telemetry\/init()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry/init()":{"fragments":[{"text":"init","kind":"identifier"},{"text":"()","kind":"text"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Initializer that generates a base64url-encoded value with telemetry data.","type":"text"}],"url":"\/documentation\/auth0\/telemetry\/init()","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","title":"init()"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","title":"Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"kind":"symbol","url":"\/documentation\/auth0\/telemetry"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/trackable.json b/docs/data/documentation/auth0/trackable.json index db061682..39ed357b 100644 --- a/docs/data/documentation/auth0/trackable.json +++ b/docs/data/documentation/auth0/trackable.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"metadata":{"externalID":"s:5Auth09TrackableP","symbolKind":"protocol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"title":"Trackable","role":"symbol","roleHeading":"Protocol","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"Trackable"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"},"abstract":[{"type":"text","text":"A type that can send the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header on every request to Auth0."}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)"],"title":"Instance Methods"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable"]}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"],"type":"inheritedBy","title":"Inherited By","kind":"relationships"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"title":"Trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/using(inLibrary:version:)":{"abstract":[{"type":"text","text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency."}],"url":"\/documentation\/auth0\/trackable\/using(inlibrary:version:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"kind":"text","text":"("},{"text":"inLibrary","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"version","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","title":"using(inLibrary:version:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/tracking(enabled:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"tracking"},{"text":"(","kind":"text"},{"text":"enabled","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":")"}],"title":"tracking(enabled:)","abstract":[{"type":"text","text":"Turn on\/off sending the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header on every request to Auth0."},{"type":"text","text":" "},{"type":"text","text":"By default we collect our libraries and SDKs versions to help us evaluate usage."}],"type":"topic","role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","url":"\/documentation\/auth0\/trackable\/tracking(enabled:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/telemetry":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV"}],"url":"\/documentation\/auth0\/trackable\/telemetry","role":"symbol","type":"topic","kind":"symbol","required":true,"abstract":[{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true},{"text":" instance.","type":"text"}],"title":"telemetry"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"title":"Authentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"url":"\/documentation\/auth0\/telemetry","title":"Telemetry","role":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","type":"link","titleInlineContent":[{"type":"text","text":"Management API v2"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"},"relationshipsSections":[{"kind":"relationships","title":"Inherited By","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"],"type":"inheritedBy"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"metadata":{"title":"Trackable","roleHeading":"Protocol","symbolKind":"protocol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Trackable"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth09TrackableP","role":"symbol","navigatorTitle":[{"text":"Trackable","kind":"identifier"}]},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)"],"title":"Instance Methods"}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/trackable"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/tracking(enabled:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/trackable\/tracking(enabled:)","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"tracking","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":")"}],"title":"tracking(enabled:)","abstract":[{"text":"Turn on\/off sending the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."},{"type":"text","text":" "},{"text":"By default we collect our libraries and SDKs versions to help us evaluate usage.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/telemetry":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry","title":"telemetry","abstract":[{"text":"The ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"reference"},{"type":"text","text":" instance."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier","text":"Telemetry"}],"kind":"symbol","url":"\/documentation\/auth0\/trackable\/telemetry","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/using(inLibrary:version:)":{"title":"using(inLibrary:version:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"kind":"externalParam","text":"inLibrary"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"version","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"url":"\/documentation\/auth0\/trackable\/using(inlibrary:version:)","abstract":[{"type":"text","text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency."}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"abstract":[{"text":"Client for the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"title":"Authentication","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Authentication"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"topic","url":"\/documentation\/auth0\/authentication","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","title":"Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"kind":"symbol","url":"\/documentation\/auth0\/telemetry"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}]},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","type":"link","titleInlineContent":[{"type":"text","text":"Management API v2"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/trackable/telemetry.json b/docs/data/documentation/auth0/trackable/telemetry.json index b2d4772f..3ba91a69 100644 --- a/docs/data/documentation/auth0/trackable/telemetry.json +++ b/docs/data/documentation/auth0/trackable/telemetry.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/trackable\/telemetry"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"telemetry"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" "},{"text":"set","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"]}]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"required":true,"externalID":"s:5Auth09TrackableP9telemetryAA9TelemetryVvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier","text":"Telemetry"}],"roleHeading":"Instance Property","role":"symbol","title":"telemetry","symbolKind":"property"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"The "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"reference","isActive":true},{"type":"text","text":" instance."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable/telemetry":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV"}],"url":"\/documentation\/auth0\/trackable\/telemetry","role":"symbol","type":"topic","kind":"symbol","required":true,"abstract":[{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true},{"text":" instance.","type":"text"}],"title":"telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"url":"\/documentation\/auth0\/telemetry","title":"Telemetry","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"title":"Trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","type":"topic","role":"symbol"}}} \ No newline at end of file +{"sections":[],"abstract":[{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true},{"type":"text","text":" instance."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"metadata":{"title":"telemetry","role":"symbol","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier","text":"Telemetry"}],"modules":[{"name":"Auth0"}],"symbolKind":"property","required":true,"externalID":"s:5Auth09TrackableP9telemetryAA9TelemetryVvp"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","text":"Telemetry"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"text":" ","kind":"text"},{"text":"set","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/telemetry"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/trackable"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","title":"Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"kind":"symbol","url":"\/documentation\/auth0\/telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/telemetry":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry","title":"telemetry","abstract":[{"text":"The ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"reference"},{"type":"text","text":" instance."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier","text":"Telemetry"}],"kind":"symbol","url":"\/documentation\/auth0\/trackable\/telemetry","required":true}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/trackable/tracking(enabled:).json b/docs/data/documentation/auth0/trackable/tracking(enabled:).json index 3d65a569..c8e174ed 100644 --- a/docs/data/documentation/auth0/trackable/tracking(enabled:).json +++ b/docs/data/documentation/auth0/trackable/tracking(enabled:).json @@ -1 +1 @@ -{"metadata":{"symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"tracking"},{"kind":"text","text":"("},{"text":"enabled","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":")","kind":"text"}],"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","title":"tracking(enabled:)","roleHeading":"Instance Method","externalID":"s:5Auth09TrackablePAAE8tracking7enabledySb_tF"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"mutating","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"tracking"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":")"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Flag to turn telemetry on\/off.","type":"text"}],"type":"paragraph"}],"name":"enabled"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Turn on\/off sending the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."},{"type":"text","text":" "},{"type":"text","text":"By default we collect our libraries and SDKs versions to help us evaluate usage."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/tracking(enabled:)"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"title":"Trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/tracking(enabled:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"tracking"},{"text":"(","kind":"text"},{"text":"enabled","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":")"}],"title":"tracking(enabled:)","abstract":[{"type":"text","text":"Turn on\/off sending the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header on every request to Auth0."},{"type":"text","text":" "},{"type":"text","text":"By default we collect our libraries and SDKs versions to help us evaluate usage."}],"type":"topic","role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","url":"\/documentation\/auth0\/trackable\/tracking(enabled:)"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/tracking(enabled:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"mutating","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"tracking","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":")","kind":"text"}]}]},{"parameters":[{"name":"enabled","content":[{"inlineContent":[{"type":"text","text":"Flag to turn telemetry on\/off."}],"type":"paragraph"}]}],"kind":"parameters"}],"abstract":[{"text":"Turn on\/off sending the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"text":" header on every request to Auth0.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"By default we collect our libraries and SDKs versions to help us evaluate usage."}],"metadata":{"extendedModule":"Auth0","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"tracking","kind":"identifier"},{"kind":"text","text":"("},{"text":"enabled","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":")"}],"externalID":"s:5Auth09TrackablePAAE8tracking7enabledySb_tF","role":"symbol","symbolKind":"method","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","title":"tracking(enabled:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/tracking(enabled:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/trackable\/tracking(enabled:)","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"tracking","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":")"}],"title":"tracking(enabled:)","abstract":[{"text":"Turn on\/off sending the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."},{"type":"text","text":" "},{"text":"By default we collect our libraries and SDKs versions to help us evaluate usage.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/trackable"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/trackable/using(inlibrary:version:).json b/docs/data/documentation/auth0/trackable/using(inlibrary:version:).json index b6fb08d5..433a9c43 100644 --- a/docs/data/documentation/auth0/trackable/using(inlibrary:version:).json +++ b/docs/data/documentation/auth0/trackable/using(inlibrary:version:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency."}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"extendedModule":"Auth0","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"text":"inLibrary","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"version"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}],"title":"using(inLibrary:version:)","role":"symbol","externalID":"s:5Auth09TrackablePAAE5using9inLibrary7versionySS_SStF","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"mutating","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"text":"(","kind":"text"},{"text":"inLibrary","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"name"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"version"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of library or framework that uses Auth0.swift."}]}],"name":"name"},{"name":"version","content":[{"type":"paragraph","inlineContent":[{"text":"Version of library or framework.","type":"text"}]}]}],"kind":"parameters"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/using(inlibrary:version:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"title":"Trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/using(inLibrary:version:)":{"abstract":[{"type":"text","text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency."}],"url":"\/documentation\/auth0\/trackable\/using(inlibrary:version:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"kind":"text","text":"("},{"text":"inLibrary","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"version","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"kind":"symbol","title":"using(inLibrary:version:)","role":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/using(inlibrary:version:)"]}],"metadata":{"roleHeading":"Instance Method","externalID":"s:5Auth09TrackablePAAE5using9inLibrary7versionySS_SStF","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"inLibrary"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"version","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":")","kind":"text"}],"symbolKind":"method","role":"symbol","title":"using(inLibrary:version:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"mutating","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"kind":"externalParam","text":"inLibrary"},{"text":" ","kind":"text"},{"text":"name","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"version"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Name of library or framework that uses Auth0.swift.","type":"text"}],"type":"paragraph"}],"name":"name"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Version of library or framework."}]}],"name":"version"}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"abstract":[{"text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/trackable"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/using(inLibrary:version:)":{"title":"using(inLibrary:version:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"kind":"externalParam","text":"inLibrary"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"version","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"url":"\/documentation\/auth0\/trackable\/using(inlibrary:version:)","abstract":[{"type":"text","text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency."}],"role":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/useragents.json b/docs/data/documentation/auth0/useragents.json index 0fc4c38f..bed9e0c2 100644 --- a/docs/data/documentation/auth0/useragents.json +++ b/docs/data/documentation/auth0/useragents.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","interfaceLanguage":"swift"},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"role":"article","roleHeading":"Article","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)"},"kind":"article","seeAlsoSections":[{"identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md"],"title":"Related Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/useragents"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","text":"Overview","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"Web-based authentication needs an in-app browser. Auth0.swift offers the choice of two system-provided browser APIs: ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","isActive":true,"type":"reference"},{"text":" and ","type":"text"},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller","isActive":true},{"text":".","type":"text"}]},{"level":2,"text":"When to use ASWebAuthenticationSession","anchor":"When-to-use-ASWebAuthenticationSession","type":"heading"},{"type":"paragraph","inlineContent":[{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" is an API provided specifically for performing web-based authentication. It is not meant for general-purpose browsing, and exposes a pretty limited API. "},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" can be used with or without ephemeral sessions enabled –through the "},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","isActive":true,"type":"reference"},{"type":"text","text":" option."}]},{"style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" supports using Universal Links as callback and logout URLs on iOS 174+ and macOS 14.4+."}]}],"name":"Note"},{"anchor":"Without-ephemeral-sessions-the-default","level":3,"text":"Without ephemeral sessions (the default)","type":"heading"},{"code":["Auth0"," .webAuth()"," .start { result in"," \/\/ ..."," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"By default, Auth0.swift uses "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" with "},{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"},{"text":" set to ","type":"text"},{"code":"false","type":"codeVoice"},{"type":"text","text":". This means that:"}],"type":"paragraph"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The session cookie will be shared with the Safari app.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"An alert box will be shown when logging in –and logging out– asking for consent, as the session cookie will be placed in a shared jar. This alert box is displayed and managed by ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":", not Auth0.swift, and unfortunately it is not customizable."}]}]}],"type":"unorderedList"},{"text":"You want this if…","type":"heading","anchor":"You-want-this-if","level":4},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"text":"You need SSO between your app and your website","type":"text"}],"type":"strong"},{"text":", when your website is accessed through the Safari app. SSO will not work with any other browser, like Chrome or Firefox.","type":"text"}]}]},{"content":[{"inlineContent":[{"inlineContent":[{"text":"You need SSO across apps","type":"text"}],"type":"strong"},{"text":". Since the session cookie will be placed in a shared cookie jar, it will be available for ","type":"text"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" across ","type":"text"},{"type":"emphasis","inlineContent":[{"text":"all","type":"text"}]},{"type":"text","text":" apps."}],"type":"paragraph"}]}]},{"type":"heading","text":"With ephemeral sessions","level":3,"anchor":"With-ephemeral-sessions"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0.swift allows to set "},{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"},{"type":"text","text":" to "},{"type":"codeVoice","code":"true"},{"type":"text","text":", by calling "},{"type":"codeVoice","code":"useEphemeralSession()"},{"text":".","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["Auth0"," .webAuth()"," .useEphemeralSession()"," .start { result in"," \/\/ ..."," }"]},{"inlineContent":[{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"},{"type":"text","text":" being set to "},{"type":"codeVoice","code":"true"},{"text":" means that:","type":"text"}],"type":"paragraph"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The session cookie will not be persisted. As soon as the "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" window closes, the cookie will be gone. This is akin to using a desktop browser in incognito mode."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Any features that rely on the persistence of cookies –like SSO, or “Remember this device”– ","type":"text"},{"inlineContent":[{"type":"text","text":"will not work"}],"type":"strong"},{"text":".","type":"text"}]}]},{"content":[{"inlineContent":[{"text":"No consent alert box will be shown, as the session cookie won’t be placed in a shared cookie jar.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"There will be no need to call ","type":"text"},{"type":"codeVoice","code":"clearSession()"},{"type":"text","text":". What "},{"code":"clearSession()","type":"codeVoice"},{"text":" does is remove the persisted session cookie. Now there will be no session cookie to remove, so it won’t do anything. To log the user out, just delete any stored credentials –for example, by calling the ","type":"text"},{"type":"codeVoice","code":"clear()"},{"type":"text","text":" method of the Credentials Manager."}]}]}],"type":"unorderedList"},{"type":"heading","text":"You want this if…","level":4,"anchor":"You-want-this-if"},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"You don’t need SSO at all"}]},{"type":"text","text":". Since the session cookie won’t be persisted, SSO will be effectively disabled."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"inlineContent":[{"text":"You don’t need any features that rely on the persistence of cookies","type":"text"}],"type":"strong"},{"type":"text","text":", like “Remember this device”."}],"type":"paragraph"}]}]},{"anchor":"When-to-use-SFSafariViewController","type":"heading","text":"When to use SFSafariViewController","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider())"," .start { result in"," \/\/ ..."," }"]},{"inlineContent":[{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" is a general purpose in-app browser that can also be used to perform web-based authentication. When used for this purpose, it acts as a middle ground between "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" with and without ephemeral sessions. It persists cookies, but won’t share them outside of your app. This means that:","type":"text"}],"type":"paragraph"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"text":"All the ","type":"text"},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" instances used in your app will have access to the persisted session cookie."}]}]},{"content":[{"inlineContent":[{"type":"text","text":"No consent alert box will be shown, as the session cookie won’t be placed in a shared cookie jar."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"All the features that rely on the persistence of cookies –like “Remember this device”– ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"will work"}]},{"type":"text","text":" as expected."}],"type":"paragraph"}]}]},{"type":"aside","name":"Note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" does not support using Universal Links as callback URLs."}]}],"style":"note"},{"anchor":"You-want-this-if","level":4,"type":"heading","text":"You want this if…"},{"items":[{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"You need SSO between your app and your website"}]},{"type":"text","text":", when your website is accessed through another "},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" instance in your app."}],"type":"paragraph"}]}],"type":"unorderedList"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"https://developer.apple.com/documentation/safariservices/sfsafariviewcontroller":{"title":"SFSafariViewController","titleInlineContent":[{"code":"SFSafariViewController","type":"codeVoice"}],"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller","url":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","title":"ASWebAuthenticationSession","titleInlineContent":[{"code":"ASWebAuthenticationSession","type":"codeVoice"}],"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession/3237231-prefersephemeralwebbrowsersessio":{"title":"prefersEphemeralWebBrowserSession","titleInlineContent":[{"code":"prefersEphemeralWebBrowserSession","type":"codeVoice"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio"},"https://github.com/auth0/Auth0.swift/blob/master/FAQ.md":{"url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","title":"FAQ","titleInlineContent":[{"text":"FAQ","type":"text"}],"type":"link","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents"},"kind":"article","primaryContentSections":[{"kind":"content","content":[{"type":"heading","text":"Overview","level":2,"anchor":"Overview"},{"inlineContent":[{"text":"Web-based authentication needs an in-app browser. Auth0.swift offers the choice of two system-provided browser APIs: ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","type":"reference","isActive":true},{"type":"text","text":" and "},{"identifier":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller","isActive":true,"type":"reference"},{"type":"text","text":"."}],"type":"paragraph"},{"level":2,"text":"When to use ASWebAuthenticationSession","type":"heading","anchor":"When-to-use-ASWebAuthenticationSession"},{"type":"paragraph","inlineContent":[{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" is an API provided specifically for performing web-based authentication. It is not meant for general-purpose browsing, and exposes a pretty limited API. "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" can be used with or without ephemeral sessions enabled –through the "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","isActive":true},{"type":"text","text":" option."}]},{"style":"note","name":"Note","type":"aside","content":[{"inlineContent":[{"type":"text","text":""},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" supports using Universal Links as callback and logout URLs on iOS 174+ and macOS 14.4+."}],"type":"paragraph"}]},{"text":"Without ephemeral sessions (the default)","level":3,"anchor":"Without-ephemeral-sessions-the-default","type":"heading"},{"code":["Auth0"," .webAuth()"," .start { result in"," \/\/ ..."," }"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"By default, Auth0.swift uses "},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" with "},{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"},{"type":"text","text":" set to "},{"type":"codeVoice","code":"false"},{"type":"text","text":". This means that:"}]},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"text":"The session cookie will be shared with the Safari app.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An alert box will be shown when logging in –and logging out– asking for consent, as the session cookie will be placed in a shared jar. This alert box is displayed and managed by "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":", not Auth0.swift, and unfortunately it is not customizable."}]}]}]},{"level":4,"text":"You want this if…","type":"heading","anchor":"You-want-this-if"},{"items":[{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"text":"You need SSO between your app and your website","type":"text"}]},{"type":"text","text":", when your website is accessed through the Safari app. SSO will not work with any other browser, like Chrome or Firefox."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"You need SSO across apps"}]},{"type":"text","text":". Since the session cookie will be placed in a shared cookie jar, it will be available for "},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" across ","type":"text"},{"type":"emphasis","inlineContent":[{"text":"all","type":"text"}]},{"text":" apps.","type":"text"}],"type":"paragraph"}]}],"type":"unorderedList"},{"text":"With ephemeral sessions","type":"heading","anchor":"With-ephemeral-sessions","level":3},{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0.swift allows to set "},{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"},{"text":" to ","type":"text"},{"type":"codeVoice","code":"true"},{"type":"text","text":", by calling "},{"type":"codeVoice","code":"useEphemeralSession()"},{"type":"text","text":"."}]},{"code":["Auth0"," .webAuth()"," .useEphemeralSession()"," .start { result in"," \/\/ ..."," }"],"syntax":"swift","type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"},{"type":"text","text":" being set to "},{"type":"codeVoice","code":"true"},{"text":" means that:","type":"text"}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The session cookie will not be persisted. As soon as the "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" window closes, the cookie will be gone. This is akin to using a desktop browser in incognito mode.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Any features that rely on the persistence of cookies –like SSO, or “Remember this device”– ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"will not work"}]},{"text":".","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"No consent alert box will be shown, as the session cookie won’t be placed in a shared cookie jar."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"There will be no need to call "},{"type":"codeVoice","code":"clearSession()"},{"type":"text","text":". What "},{"code":"clearSession()","type":"codeVoice"},{"type":"text","text":" does is remove the persisted session cookie. Now there will be no session cookie to remove, so it won’t do anything. To log the user out, just delete any stored credentials –for example, by calling the "},{"code":"clear()","type":"codeVoice"},{"text":" method of the Credentials Manager.","type":"text"}]}]}]},{"type":"heading","anchor":"You-want-this-if","text":"You want this if…","level":4},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"text":"You don’t need SSO at all","type":"text"}],"type":"strong"},{"type":"text","text":". Since the session cookie won’t be persisted, SSO will be effectively disabled."}]}]},{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"You don’t need any features that rely on the persistence of cookies"}]},{"text":", like “Remember this device”.","type":"text"}],"type":"paragraph"}]}]},{"type":"heading","text":"When to use SFSafariViewController","anchor":"When-to-use-SFSafariViewController","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider())"," .start { result in"," \/\/ ..."," }"]},{"inlineContent":[{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" is a general purpose in-app browser that can also be used to perform web-based authentication. When used for this purpose, it acts as a middle ground between "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" with and without ephemeral sessions. It persists cookies, but won’t share them outside of your app. This means that:"}],"type":"paragraph"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"All the "},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" instances used in your app will have access to the persisted session cookie."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"No consent alert box will be shown, as the session cookie won’t be placed in a shared cookie jar."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"All the features that rely on the persistence of cookies –like “Remember this device”– ","type":"text"},{"type":"strong","inlineContent":[{"text":"will work","type":"text"}]},{"type":"text","text":" as expected."}]}]}]},{"style":"note","type":"aside","content":[{"inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" does not support using Universal Links as callback URLs."}],"type":"paragraph"}],"name":"Note"},{"text":"You want this if…","level":4,"anchor":"You-want-this-if","type":"heading"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"You need SSO between your app and your website"}]},{"text":", when your website is accessed through another ","type":"text"},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" instance in your app."}]}]}]}]}],"metadata":{"roleHeading":"Article","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","modules":[{"name":"Auth0"}],"role":"article"},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"seeAlsoSections":[{"identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md"],"title":"Related Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/useragents"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"references":{"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession":{"title":"ASWebAuthenticationSession","type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASWebAuthenticationSession"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession"},"https://github.com/auth0/Auth0.swift/blob/master/FAQ.md":{"titleInlineContent":[{"text":"FAQ","type":"text"}],"title":"FAQ","type":"link","url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md"},"https://developer.apple.com/documentation/safariservices/sfsafariviewcontroller":{"title":"SFSafariViewController","type":"link","titleInlineContent":[{"type":"codeVoice","code":"SFSafariViewController"}],"url":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller","identifier":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession/3237231-prefersephemeralwebbrowsersessio":{"titleInlineContent":[{"code":"prefersEphemeralWebBrowserSession","type":"codeVoice"}],"title":"prefersEphemeralWebBrowserSession","type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo.json b/docs/data/documentation/auth0/userinfo.json index 9ec73aa0..11f0568f 100644 --- a/docs/data/documentation/auth0/userinfo.json +++ b/docs/data/documentation/auth0/userinfo.json @@ -1 +1 @@ -{"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo"],"title":"Instance Properties"},{"title":"Type Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"],"generated":true,"title":"Default Implementations"}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Structure","externalID":"s:5Auth08UserInfoV","title":"UserInfo","symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/birthdate":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"birthdate","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"birthdate","url":"\/documentation\/auth0\/userinfo\/birthdate","kind":"symbol","abstract":[{"type":"text","text":"The birthdate of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumber":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic","title":"phoneNumber","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/phonenumber","abstract":[{"type":"text","text":"The phone number of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumberVerified":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"phoneNumberVerified","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"phoneNumberVerified","url":"\/documentation\/auth0\/userinfo\/phonenumberverified","kind":"symbol","abstract":[{"type":"text","text":"If the user’s phone number is verified."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/givenName":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"givenName","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"type":"topic","title":"givenName","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/givenname","abstract":[{"type":"text","text":"The first name of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/emailVerified":{"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/emailverified","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"?","kind":"text"}],"type":"topic","title":"emailVerified","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","abstract":[{"text":"If the user’s email is verified.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/picture":{"abstract":[{"type":"text","text":"The URL of the user’s picture."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"picture","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"title":"picture","url":"\/documentation\/auth0\/userinfo\/picture","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/middleName":{"abstract":[{"type":"text","text":"The middle name of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"middleName","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"middleName","url":"\/documentation\/auth0\/userinfo\/middlename","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/locale":{"abstract":[{"type":"text","text":"The locale of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"locale","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV","text":"Locale"},{"kind":"text","text":"?"}],"title":"locale","url":"\/documentation\/auth0\/userinfo\/locale","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/sub":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"sub"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/sub","type":"topic","title":"sub","abstract":[{"type":"text","text":"The Auth0 user identifier."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/gender":{"abstract":[{"type":"text","text":"The gender of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"gender","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"gender","url":"\/documentation\/auth0\/userinfo\/gender","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/address":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"address"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?","kind":"text"}],"title":"address","kind":"symbol","role":"symbol","type":"topic","abstract":[{"type":"text","text":"The address of the user."}],"url":"\/documentation\/auth0\/userinfo\/address"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/familyName":{"abstract":[{"type":"text","text":"The last name of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"familyName","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"familyName","url":"\/documentation\/auth0\/userinfo\/familyname","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/nickname":{"abstract":[{"type":"text","text":"The nickname of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"nickname","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"nickname","url":"\/documentation\/auth0\/userinfo\/nickname","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/publicClaims":{"abstract":[{"type":"text","text":"The list of public claims."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicClaims"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]"}],"title":"publicClaims","url":"\/documentation\/auth0\/userinfo\/publicclaims","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/JSONObjectPayload-Implementations":{"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations","type":"topic","title":"JSONObjectPayload Implementations","url":"\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations","role":"collectionGroup","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/website":{"abstract":[{"type":"text","text":"The URL of the user’s website."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"website"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"website","url":"\/documentation\/auth0\/userinfo\/website","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/zoneinfo":{"abstract":[{"text":"The time zone of the user.","type":"text"}],"title":"zoneinfo","role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/zoneinfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"zoneinfo","kind":"identifier"},{"kind":"text","text":": "},{"text":"TimeZone","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation8TimeZoneV"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/email":{"abstract":[{"type":"text","text":"The email of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"email","url":"\/documentation\/auth0\/userinfo\/email","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/updatedAt":{"abstract":[{"type":"text","text":"The date and time the user’s information was last updated."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"updatedAt","url":"\/documentation\/auth0\/userinfo\/updatedat","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/customClaims":{"abstract":[{"text":"Any custom claims.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/customclaims","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"customClaims","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?","kind":"text"}],"role":"symbol","type":"topic","title":"customClaims"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/preferredUsername":{"abstract":[{"type":"text","text":"The preferred username of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"preferredUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"preferredUsername","url":"\/documentation\/auth0\/userinfo\/preferredusername","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/profile":{"abstract":[{"type":"text","text":"The URL of the user’s profile page."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"profile"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"profile","url":"\/documentation\/auth0\/userinfo\/profile","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/name":{"abstract":[{"text":"The name of the user.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"name","url":"\/documentation\/auth0\/userinfo\/name","role":"symbol","kind":"symbol"},"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-token-claims":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims","title":"Claims","titleInlineContent":[{"type":"text","text":"Claims"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims"}}} \ No newline at end of file +{"metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"struct","title":"UserInfo","externalID":"s:5Auth08UserInfoV","roleHeading":"Structure"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims"],"title":"Type Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"],"title":"Default Implementations","generated":true}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims"],"title":"Related Documentation"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumber":{"type":"topic","abstract":[{"type":"text","text":"The phone number of the user."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","title":"phoneNumber","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/phonenumber"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/publicClaims":{"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"publicClaims"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","url":"\/documentation\/auth0\/userinfo\/publicclaims","type":"topic","abstract":[{"text":"The list of public claims.","type":"text"}],"kind":"symbol","title":"publicClaims","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/picture":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"picture","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/picture","title":"picture","abstract":[{"type":"text","text":"The URL of the user’s picture."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumberVerified":{"url":"\/documentation\/auth0\/userinfo\/phonenumberverified","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"phoneNumberVerified","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"If the user’s phone number is verified."}],"type":"topic","title":"phoneNumberVerified"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/preferredUsername":{"url":"\/documentation\/auth0\/userinfo\/preferredusername","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"preferredUsername","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The preferred username of the user."}],"kind":"symbol","title":"preferredUsername","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/profile":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","title":"profile","abstract":[{"text":"The URL of the user’s profile page.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"profile","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/profile"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/sub":{"url":"\/documentation\/auth0\/userinfo\/sub","kind":"symbol","title":"sub","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"sub"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","type":"topic","abstract":[{"type":"text","text":"The Auth0 user identifier."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/zoneinfo":{"url":"\/documentation\/auth0\/userinfo\/zoneinfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo","title":"zoneinfo","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"The time zone of the user."}],"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"zoneinfo","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation8TimeZoneV","text":"TimeZone","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/emailVerified":{"kind":"symbol","role":"symbol","type":"topic","title":"emailVerified","url":"\/documentation\/auth0\/userinfo\/emailverified","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","abstract":[{"text":"If the user’s email is verified.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/customClaims":{"abstract":[{"text":"Any custom claims.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"customClaims","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/userinfo\/customclaims","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","kind":"symbol","title":"customClaims"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/JSONObjectPayload-Implementations":{"abstract":[],"role":"collectionGroup","type":"topic","title":"JSONObjectPayload Implementations","url":"\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-token-claims":{"title":"Claims","titleInlineContent":[{"type":"text","text":"Claims"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/birthdate":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"birthdate","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","title":"birthdate","url":"\/documentation\/auth0\/userinfo\/birthdate","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"The birthdate of the user."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/locale":{"url":"\/documentation\/auth0\/userinfo\/locale","kind":"symbol","title":"locale","abstract":[{"type":"text","text":"The locale of the user."}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"locale","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Locale","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/givenName":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","url":"\/documentation\/auth0\/userinfo\/givenname","abstract":[{"type":"text","text":"The first name of the user."}],"title":"givenName","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"givenName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/name":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","abstract":[{"text":"The name of the user.","type":"text"}],"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","title":"name","role":"symbol","url":"\/documentation\/auth0\/userinfo\/name"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/email":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","abstract":[{"text":"The email of the user.","type":"text"}],"title":"email","type":"topic","role":"symbol","url":"\/documentation\/auth0\/userinfo\/email","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/gender":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"gender"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"type":"topic","kind":"symbol","title":"gender","url":"\/documentation\/auth0\/userinfo\/gender","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","abstract":[{"type":"text","text":"The gender of the user."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/nickname":{"type":"topic","role":"symbol","url":"\/documentation\/auth0\/userinfo\/nickname","kind":"symbol","abstract":[{"type":"text","text":"The nickname of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","title":"nickname","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nickname","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/familyName":{"abstract":[{"type":"text","text":"The last name of the user."}],"url":"\/documentation\/auth0\/userinfo\/familyname","title":"familyName","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"familyName"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/updatedAt":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","url":"\/documentation\/auth0\/userinfo\/updatedat","role":"symbol","abstract":[{"type":"text","text":"The date and time the user’s information was last updated."}],"title":"updatedAt","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"updatedAt","kind":"identifier"},{"kind":"text","text":": "},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/website":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","title":"website","abstract":[{"type":"text","text":"The URL of the user’s website."}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"website","kind":"identifier"},{"kind":"text","text":": "},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/website"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/address":{"title":"address","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"address"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/address","abstract":[{"type":"text","text":"The address of the user."}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/middleName":{"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"The middle name of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","title":"middleName","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"middleName","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/middlename"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/address.json b/docs/data/documentation/auth0/userinfo/address.json index ea187635..c7006d7e 100644 --- a/docs/data/documentation/auth0/userinfo/address.json +++ b/docs/data/documentation/auth0/userinfo/address.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"address"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"address","type":"codeVoice"},{"type":"text","text":" scope."}]}],"name":"Requires","type":"aside","style":"note"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"roleHeading":"Instance Property","title":"address","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"address","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]?"}],"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","externalID":"s:5Auth08UserInfoV7addressSDyS2SGSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/address"]}],"abstract":[{"type":"text","text":"The address of the user."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/address":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"address"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?","kind":"text"}],"title":"address","kind":"symbol","role":"symbol","type":"topic","abstract":[{"type":"text","text":"The address of the user."}],"url":"\/documentation\/auth0\/userinfo\/address"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address"},"kind":"symbol","abstract":[{"type":"text","text":"The address of the user."}],"metadata":{"title":"address","roleHeading":"Instance Property","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"address"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]?","kind":"text"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV7addressSDyS2SGSgvp","role":"symbol"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"address"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"style":"note","type":"aside","name":"Requires","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"address"},{"type":"text","text":" scope."}],"type":"paragraph"}]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/address"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/address":{"title":"address","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"address"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/address","abstract":[{"type":"text","text":"The address of the user."}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/birthdate.json b/docs/data/documentation/auth0/userinfo/birthdate.json index 4a4a1ffa..d8223eb6 100644 --- a/docs/data/documentation/auth0/userinfo/birthdate.json +++ b/docs/data/documentation/auth0/userinfo/birthdate.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/birthdate"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"birthdate"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","level":2,"type":"heading"},{"type":"aside","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"style":"note"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","interfaceLanguage":"swift"},"sections":[],"metadata":{"title":"birthdate","role":"symbol","roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"birthdate"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"externalID":"s:5Auth08UserInfoV9birthdateSSSgvp"},"abstract":[{"type":"text","text":"The birthdate of the user."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/birthdate":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"birthdate","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"birthdate","url":"\/documentation\/auth0\/userinfo\/birthdate","kind":"symbol","abstract":[{"type":"text","text":"The birthdate of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"The birthdate of the user."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate"},"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"kind":"symbol","sections":[],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","title":"birthdate","externalID":"s:5Auth08UserInfoV9birthdateSSSgvp","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"birthdate","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","role":"symbol"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"birthdate","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"type":"aside","name":"Requires","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}]}]}]}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/birthdate"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/birthdate":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"birthdate","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","title":"birthdate","url":"\/documentation\/auth0\/userinfo\/birthdate","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"The birthdate of the user."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/customclaims.json b/docs/data/documentation/auth0/userinfo/customclaims.json index ae152cbf..0080ea0f 100644 --- a/docs/data/documentation/auth0/userinfo/customclaims.json +++ b/docs/data/documentation/auth0/userinfo/customclaims.json @@ -1 +1 @@ -{"sections":[],"metadata":{"title":"customClaims","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"customClaims"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]?","kind":"text"}],"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV12customClaimsSDySSypGSgvp","symbolKind":"property","role":"symbol"},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"customClaims","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?"}],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"type":"text","text":"Any custom claims."}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/customclaims"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/customClaims":{"abstract":[{"text":"Any custom claims.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/customclaims","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"customClaims","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?","kind":"text"}],"role":"symbol","type":"topic","title":"customClaims"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/customclaims"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"customClaims","kind":"identifier"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"text":"Any custom claims.","type":"text"}],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV12customClaimsSDySSypGSgvp","symbolKind":"property","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"customClaims","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]?","kind":"text"}],"title":"customClaims"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/customClaims":{"abstract":[{"text":"Any custom claims.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"customClaims","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/userinfo\/customclaims","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","kind":"symbol","title":"customClaims"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/email.json b/docs/data/documentation/auth0/userinfo/email.json index ea8a5402..49ea3b93 100644 --- a/docs/data/documentation/auth0/userinfo/email.json +++ b/docs/data/documentation/auth0/userinfo/email.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/email"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"email","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"style":"note","type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"email","type":"codeVoice"},{"type":"text","text":" scope."}]}]}]}],"abstract":[{"type":"text","text":"The email of the user."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email"},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"email","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol","title":"email","externalID":"s:5Auth08UserInfoV5emailSSSgvp"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/email":{"abstract":[{"type":"text","text":"The email of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"email","url":"\/documentation\/auth0\/userinfo\/email","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"email","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"externalID":"s:5Auth08UserInfoV5emailSSSgvp","title":"email","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"abstract":[{"type":"text","text":"The email of the user."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/email"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"email"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"email"},{"type":"text","text":" scope."}]}],"name":"Requires","style":"note","type":"aside"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/email":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","abstract":[{"text":"The email of the user.","type":"text"}],"title":"email","type":"topic","role":"symbol","url":"\/documentation\/auth0\/userinfo\/email","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/emailverified.json b/docs/data/documentation/auth0/userinfo/emailverified.json index 1812b488..5ced9659 100644 --- a/docs/data/documentation/auth0/userinfo/emailverified.json +++ b/docs/data/documentation/auth0/userinfo/emailverified.json @@ -1 +1 @@ -{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"emailVerified"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"name":"Requires","type":"aside","style":"note","content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"email","type":"codeVoice"},{"type":"text","text":" scope."}],"type":"paragraph"}]}]}],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"?","kind":"text"}],"title":"emailVerified","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV13emailVerifiedSbSgvp"},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/emailverified"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"If the user’s email is verified."}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/emailVerified":{"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/emailverified","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"?","kind":"text"}],"type":"topic","title":"emailVerified","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","abstract":[{"text":"If the user’s email is verified.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"name":"Requires","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"email"},{"text":" scope.","type":"text"}]}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified"},"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","abstract":[{"type":"text","text":"If the user’s email is verified."}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"emailVerified","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"emailVerified","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?","kind":"text"}],"externalID":"s:5Auth08UserInfoV13emailVerifiedSbSgvp","symbolKind":"property","roleHeading":"Instance Property"},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/emailverified"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/emailVerified":{"kind":"symbol","role":"symbol","type":"topic","title":"emailVerified","url":"\/documentation\/auth0\/userinfo\/emailverified","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","abstract":[{"text":"If the user’s email is verified.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/familyname.json b/docs/data/documentation/auth0/userinfo/familyname.json index 795b9791..ad379a61 100644 --- a/docs/data/documentation/auth0/userinfo/familyname.json +++ b/docs/data/documentation/auth0/userinfo/familyname.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/familyname"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"familyName"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"name":"Requires","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName"},"metadata":{"role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV10familyNameSSSgvp","title":"familyName","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"familyName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"symbolKind":"property","modules":[{"name":"Auth0"}]},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"text":"The last name of the user.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/familyName":{"abstract":[{"type":"text","text":"The last name of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"familyName","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"familyName","url":"\/documentation\/auth0\/userinfo\/familyname","role":"symbol","kind":"symbol"}}} \ No newline at end of file +{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/familyname"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","interfaceLanguage":"swift"},"abstract":[{"text":"The last name of the user.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"familyName","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","anchor":"discussion","text":"Discussion","level":2},{"content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}],"type":"aside","name":"Requires","style":"note"}]}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"title":"familyName","symbolKind":"property","externalID":"s:5Auth08UserInfoV10familyNameSSSgvp","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"familyName"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/familyName":{"abstract":[{"type":"text","text":"The last name of the user."}],"url":"\/documentation\/auth0\/userinfo\/familyname","title":"familyName","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"familyName"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/gender.json b/docs/data/documentation/auth0/userinfo/gender.json index b5cdafa3..578a8656 100644 --- a/docs/data/documentation/auth0/userinfo/gender.json +++ b/docs/data/documentation/auth0/userinfo/gender.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/gender"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"title":"gender","externalID":"s:5Auth08UserInfoV6genderSSSgvp","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"gender","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property","modules":[{"name":"Auth0"}]},"abstract":[{"type":"text","text":"The gender of the user."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"gender"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]}]},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","level":2,"type":"heading"},{"style":"note","type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/gender":{"abstract":[{"type":"text","text":"The gender of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"gender","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"gender","url":"\/documentation\/auth0\/userinfo\/gender","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"gender"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}]}]},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"aside","name":"Requires","style":"note","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}]}],"kind":"content"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The gender of the user."}],"sections":[],"metadata":{"externalID":"s:5Auth08UserInfoV6genderSSSgvp","modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","title":"gender","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"gender","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}]},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/gender"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/gender":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"gender"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"type":"topic","kind":"symbol","title":"gender","url":"\/documentation\/auth0\/userinfo\/gender","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","abstract":[{"type":"text","text":"The gender of the user."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/givenname.json b/docs/data/documentation/auth0/userinfo/givenname.json index 95c93a4f..87966895 100644 --- a/docs/data/documentation/auth0/userinfo/givenname.json +++ b/docs/data/documentation/auth0/userinfo/givenname.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/givenname"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"The first name of the user."}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"givenName"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"languages":["swift"]}]},{"content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}],"type":"aside","name":"Requires","style":"note"}],"kind":"content"}],"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"givenName"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth08UserInfoV9givenNameSSSgvp","role":"symbol","title":"givenName","roleHeading":"Instance Property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/givenName":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"givenName","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"type":"topic","title":"givenName","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/givenname","abstract":[{"type":"text","text":"The first name of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"symbolKind":"property","title":"givenName","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV9givenNameSSSgvp","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"givenName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"role":"symbol"},"abstract":[{"text":"The first name of the user.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/givenname"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"givenName","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}]}],"style":"note","type":"aside","name":"Requires"}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/givenName":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","url":"\/documentation\/auth0\/userinfo\/givenname","abstract":[{"type":"text","text":"The first name of the user."}],"title":"givenName","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"givenName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/init(json:).json b/docs/data/documentation/auth0/userinfo/init(json:).json index 8e515b02..78bf1a00 100644 --- a/docs/data/documentation/auth0/userinfo/init(json:).json +++ b/docs/data/documentation/auth0/userinfo/init(json:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/init(json:)"]}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"]]},"abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"UserInfo"},{"type":"text","text":" from a JSON dictionary."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)"},"metadata":{"roleHeading":"Initializer","extendedModule":"Auth0","title":"init(json:)","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"text":"json","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV4jsonACSgSDySSypG_tcfc"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"text":"?(","kind":"text"},{"text":"json","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/JSONObjectPayload-Implementations":{"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations","type":"topic","title":"JSONObjectPayload Implementations","url":"\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations","role":"collectionGroup","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/init(json:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)","title":"init(json:)","role":"symbol","type":"topic","fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"text":"json","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"UserInfo"},{"type":"text","text":" from a JSON dictionary."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/init(json:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Creates a new "},{"code":"UserInfo","type":"codeVoice"},{"text":" from a JSON dictionary.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"text":"?(","kind":"text"},{"text":"json","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"]]},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/init(json:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"kind":"externalParam","text":"json"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"title":"init(json:)","symbolKind":"init","extendedModule":"Auth0","externalID":"s:5Auth08UserInfoV4jsonACSgSDySSypG_tcfc"},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/JSONObjectPayload-Implementations":{"abstract":[],"role":"collectionGroup","type":"topic","title":"JSONObjectPayload Implementations","url":"\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/init(json:)":{"abstract":[{"type":"text","text":"Creates a new "},{"code":"UserInfo","type":"codeVoice"},{"text":" from a JSON dictionary.","type":"text"}],"fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"json"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"])"}],"role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/init(json:)","title":"init(json:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/jsonobjectpayload-implementations.json b/docs/data/documentation/auth0/userinfo/jsonobjectpayload-implementations.json index d3e2a445..bcb89dee 100644 --- a/docs/data/documentation/auth0/userinfo/jsonobjectpayload-implementations.json +++ b/docs/data/documentation/auth0/userinfo/jsonobjectpayload-implementations.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations"]}],"kind":"article","sections":[],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)"],"generated":true}],"metadata":{"modules":[{"name":"Auth0"}],"title":"JSONObjectPayload Implementations","role":"collectionGroup","roleHeading":"API Collection"},"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/init(json:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)","title":"init(json:)","role":"symbol","type":"topic","fragments":[{"kind":"identifier","text":"init"},{"text":"?(","kind":"text"},{"text":"json","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"UserInfo"},{"type":"text","text":" from a JSON dictionary."}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/init(json:)"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"roleHeading":"API Collection","title":"JSONObjectPayload Implementations","modules":[{"name":"Auth0"}],"role":"collectionGroup"},"topicSections":[{"generated":true,"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)"]}],"sections":[],"kind":"article","variants":[{"paths":["\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/JSONObjectPayload-Implementations","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/init(json:)":{"abstract":[{"type":"text","text":"Creates a new "},{"code":"UserInfo","type":"codeVoice"},{"text":" from a JSON dictionary.","type":"text"}],"fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"json"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"])"}],"role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/init(json:)","title":"init(json:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/locale.json b/docs/data/documentation/auth0/userinfo/locale.json index 116ed1fb..30d2ea18 100644 --- a/docs/data/documentation/auth0/userinfo/locale.json +++ b/docs/data/documentation/auth0/userinfo/locale.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"locale"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV","text":"Locale"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}]}],"name":"Requires","style":"note","type":"aside"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"The locale of the user."}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","interfaceLanguage":"swift"},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"locale"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation6LocaleV","text":"Locale","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV6locale10Foundation6LocaleVSgvp","title":"locale","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/locale"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/locale":{"abstract":[{"type":"text","text":"The locale of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"locale","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV","text":"Locale"},{"kind":"text","text":"?"}],"title":"locale","url":"\/documentation\/auth0\/userinfo\/locale","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"locale"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV","text":"Locale"},{"kind":"text","text":"?"}]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"style":"note","type":"aside","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}],"name":"Requires"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/locale"]}],"abstract":[{"text":"The locale of the user.","type":"text"}],"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"title":"locale","symbolKind":"property","externalID":"s:5Auth08UserInfoV6locale10Foundation6LocaleVSgvp","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"locale","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Locale","preciseIdentifier":"s:10Foundation6LocaleV","kind":"typeIdentifier"},{"kind":"text","text":"?"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/locale":{"url":"\/documentation\/auth0\/userinfo\/locale","kind":"symbol","title":"locale","abstract":[{"type":"text","text":"The locale of the user."}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"locale","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Locale","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/middlename.json b/docs/data/documentation/auth0/userinfo/middlename.json index 3f1c3938..a16fe56a 100644 --- a/docs/data/documentation/auth0/userinfo/middlename.json +++ b/docs/data/documentation/auth0/userinfo/middlename.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName"},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","title":"middleName","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"middleName","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth08UserInfoV10middleNameSSSgvp"},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/middlename"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"middleName","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"name":"Requires","content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note"}]}],"abstract":[{"type":"text","text":"The middle name of the user."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/middleName":{"abstract":[{"type":"text","text":"The middle name of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"middleName","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"middleName","url":"\/documentation\/auth0\/userinfo\/middlename","role":"symbol","kind":"symbol"}}} \ No newline at end of file +{"abstract":[{"text":"The middle name of the user.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName"},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"middleName","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","level":2,"type":"heading"},{"content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}],"name":"Requires","style":"note","type":"aside"}]}],"sections":[],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/middlename"]}],"metadata":{"roleHeading":"Instance Property","title":"middleName","role":"symbol","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"middleName"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV10middleNameSSSgvp"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/middleName":{"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"The middle name of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","title":"middleName","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"middleName","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/middlename"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/name.json b/docs/data/documentation/auth0/userinfo/name.json index fb5a071a..bf25a471 100644 --- a/docs/data/documentation/auth0/userinfo/name.json +++ b/docs/data/documentation/auth0/userinfo/name.json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"The name of the user."}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/name"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"name","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"name":"Requires","type":"aside","style":"note"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"title":"name","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV4nameSSSgvp"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/name":{"abstract":[{"text":"The name of the user.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"name","url":"\/documentation\/auth0\/userinfo\/name","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth08UserInfoV4nameSSSgvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"name"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}]}]},{"kind":"content","content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"style":"note","name":"Requires","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}],"type":"paragraph"}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"The name of the user.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/name"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/name":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","abstract":[{"text":"The name of the user.","type":"text"}],"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","title":"name","role":"symbol","url":"\/documentation\/auth0\/userinfo\/name"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/nickname.json b/docs/data/documentation/auth0/userinfo/nickname.json index 274b4918..770aea12 100644 --- a/docs/data/documentation/auth0/userinfo/nickname.json +++ b/docs/data/documentation/auth0/userinfo/nickname.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/userinfo\/nickname"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The nickname of the user."}],"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"title":"nickname","symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV8nicknameSSSgvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nickname","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"nickname","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]}]},{"content":[{"anchor":"discussion","type":"heading","text":"Discussion","level":2},{"type":"aside","style":"note","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}]}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/nickname":{"abstract":[{"type":"text","text":"The nickname of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"nickname","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"nickname","url":"\/documentation\/auth0\/userinfo\/nickname","role":"symbol","kind":"symbol"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/userinfo\/nickname"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The nickname of the user."}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"nickname","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"name":"Requires","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}]}]}]}],"sections":[],"metadata":{"role":"symbol","title":"nickname","symbolKind":"property","externalID":"s:5Auth08UserInfoV8nicknameSSSgvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"nickname","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/nickname":{"type":"topic","role":"symbol","url":"\/documentation\/auth0\/userinfo\/nickname","kind":"symbol","abstract":[{"type":"text","text":"The nickname of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","title":"nickname","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nickname","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/phonenumber.json b/docs/data/documentation/auth0/userinfo/phonenumber.json index f872f41d..a3cab347 100644 --- a/docs/data/documentation/auth0/userinfo/phonenumber.json +++ b/docs/data/documentation/auth0/userinfo/phonenumber.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/phonenumber"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber"},"abstract":[{"type":"text","text":"The phone number of the user."}],"sections":[],"kind":"symbol","metadata":{"title":"phoneNumber","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV11phoneNumberSSSgvp","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"name":"Requires","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"phone_number"},{"text":" scope.","type":"text"}]}],"style":"note"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumber":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic","title":"phoneNumber","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/phonenumber","abstract":[{"type":"text","text":"The phone number of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"}}} \ No newline at end of file +{"metadata":{"role":"symbol","title":"phoneNumber","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"symbolKind":"property","externalID":"s:5Auth08UserInfoV11phoneNumberSSSgvp"},"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","abstract":[{"text":"The phone number of the user.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/phonenumber"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"type":"aside","name":"Requires","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"phone_number"},{"type":"text","text":" scope."}]}]}],"kind":"content"}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumber":{"type":"topic","abstract":[{"type":"text","text":"The phone number of the user."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","title":"phoneNumber","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/phonenumber"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/phonenumberverified.json b/docs/data/documentation/auth0/userinfo/phonenumberverified.json index 35d0f0a2..fef2c0de 100644 --- a/docs/data/documentation/auth0/userinfo/phonenumberverified.json +++ b/docs/data/documentation/auth0/userinfo/phonenumberverified.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"If the user’s phone number is verified."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/phonenumberverified"]}],"metadata":{"symbolKind":"property","role":"symbol","externalID":"s:5Auth08UserInfoV19phoneNumberVerifiedSbSgvp","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"phoneNumberVerified"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":"?","kind":"text"}],"title":"phoneNumberVerified","roleHeading":"Instance Property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"phoneNumberVerified","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"?","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"phone_number"},{"text":" scope.","type":"text"}]}],"name":"Requires"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumberVerified":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"phoneNumberVerified","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"phoneNumberVerified","url":"\/documentation\/auth0\/userinfo\/phonenumberverified","kind":"symbol","abstract":[{"type":"text","text":"If the user’s phone number is verified."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth08UserInfoV19phoneNumberVerifiedSbSgvp","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumberVerified"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?"}],"title":"phoneNumberVerified"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"text":"If the user’s phone number is verified.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/phonenumberverified"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"phoneNumberVerified","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"name":"Requires","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"phone_number"},{"text":" scope.","type":"text"}]}],"style":"note"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumberVerified":{"url":"\/documentation\/auth0\/userinfo\/phonenumberverified","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"phoneNumberVerified","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"If the user’s phone number is verified."}],"type":"topic","title":"phoneNumberVerified"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/picture.json b/docs/data/documentation/auth0/userinfo/picture.json index f2a0404b..d8a6acc4 100644 --- a/docs/data/documentation/auth0/userinfo/picture.json +++ b/docs/data/documentation/auth0/userinfo/picture.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"abstract":[{"type":"text","text":"The URL of the user’s picture."}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","title":"picture","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"picture"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"externalID":"s:5Auth08UserInfoV7picture10Foundation3URLVSgvp","roleHeading":"Instance Property"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"picture","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"text":"?","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"type":"aside","style":"note","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}]}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/picture"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/picture":{"abstract":[{"type":"text","text":"The URL of the user’s picture."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"picture","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"title":"picture","url":"\/documentation\/auth0\/userinfo\/picture","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/picture"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"The URL of the user’s picture.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"picture"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"anchor":"discussion","type":"heading","text":"Discussion","level":2},{"content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note","name":"Requires"}],"kind":"content"}],"metadata":{"role":"symbol","title":"picture","symbolKind":"property","externalID":"s:5Auth08UserInfoV7picture10Foundation3URLVSgvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"picture","kind":"identifier"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/picture":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"picture","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/picture","title":"picture","abstract":[{"type":"text","text":"The URL of the user’s picture."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/preferredusername.json b/docs/data/documentation/auth0/userinfo/preferredusername.json index 9935124b..121f61e9 100644 --- a/docs/data/documentation/auth0/userinfo/preferredusername.json +++ b/docs/data/documentation/auth0/userinfo/preferredusername.json @@ -1 +1 @@ -{"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"preferredUsername"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"preferredUsername","externalID":"s:5Auth08UserInfoV17preferredUsernameSSSgvp","modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","role":"symbol"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"preferredUsername"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"discussion","text":"Discussion","level":2},{"type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}],"style":"note"}],"kind":"content"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/preferredusername"]}],"kind":"symbol","abstract":[{"type":"text","text":"The preferred username of the user."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/preferredUsername":{"abstract":[{"type":"text","text":"The preferred username of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"preferredUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"preferredUsername","url":"\/documentation\/auth0\/userinfo\/preferredusername","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"preferredUsername"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"style":"note","name":"Requires","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}],"type":"paragraph"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"type":"text","text":"The preferred username of the user."}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/preferredusername"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"externalID":"s:5Auth08UserInfoV17preferredUsernameSSSgvp","symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"preferredUsername","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"title":"preferredUsername","role":"symbol"},"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/preferredUsername":{"url":"\/documentation\/auth0\/userinfo\/preferredusername","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"preferredUsername","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The preferred username of the user."}],"kind":"symbol","title":"preferredUsername","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/profile.json b/docs/data/documentation/auth0/userinfo/profile.json index d7681e25..a055fb3c 100644 --- a/docs/data/documentation/auth0/userinfo/profile.json +++ b/docs/data/documentation/auth0/userinfo/profile.json @@ -1 +1 @@ -{"kind":"symbol","metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"profile"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","symbolKind":"property","title":"profile","role":"symbol","externalID":"s:5Auth08UserInfoV7profile10Foundation3URLVSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The URL of the user’s profile page."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"profile","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"type":"aside","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}],"name":"Requires","style":"note"}],"kind":"content"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/profile"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/profile":{"abstract":[{"type":"text","text":"The URL of the user’s profile page."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"profile"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"profile","url":"\/documentation\/auth0\/userinfo\/profile","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"profile"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}],"style":"note","type":"aside"}]}],"metadata":{"role":"symbol","roleHeading":"Instance Property","title":"profile","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"profile","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV7profile10Foundation3URLVSgvp"},"abstract":[{"type":"text","text":"The URL of the user’s profile page."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/profile"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/profile":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","title":"profile","abstract":[{"text":"The URL of the user’s profile page.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"profile","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/profile"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/publicclaims.json b/docs/data/documentation/auth0/userinfo/publicclaims.json index ffc6e810..c9fb3847 100644 --- a/docs/data/documentation/auth0/userinfo/publicclaims.json +++ b/docs/data/documentation/auth0/userinfo/publicclaims.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"The list of public claims."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"publicClaims","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"]"}],"title":"publicClaims","externalID":"s:5Auth08UserInfoV12publicClaimsSaySSGvpZ","roleHeading":"Type Property"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/publicclaims"]}],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicClaims"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]","kind":"text"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/publicClaims":{"abstract":[{"type":"text","text":"The list of public claims."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicClaims"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]"}],"title":"publicClaims","url":"\/documentation\/auth0\/userinfo\/publicclaims","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/userinfo\/publicclaims"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"The list of public claims.","type":"text"}],"sections":[],"metadata":{"symbolKind":"property","roleHeading":"Type Property","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"publicClaims","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]","kind":"text"}],"externalID":"s:5Auth08UserInfoV12publicClaimsSaySSGvpZ","title":"publicClaims","role":"symbol","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicClaims"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]"}]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/publicClaims":{"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"publicClaims"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","url":"\/documentation\/auth0\/userinfo\/publicclaims","type":"topic","abstract":[{"text":"The list of public claims.","type":"text"}],"kind":"symbol","title":"publicClaims","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/sub.json b/docs/data/documentation/auth0/userinfo/sub.json index 35ce9c9c..6b0ca68b 100644 --- a/docs/data/documentation/auth0/userinfo/sub.json +++ b/docs/data/documentation/auth0/userinfo/sub.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"sub","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"text":"The Auth0 user identifier.","type":"text"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/sub"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"sub"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"externalID":"s:5Auth08UserInfoV3subSSvp","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"sub","role":"symbol","roleHeading":"Instance Property"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/sub":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"sub"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/sub","type":"topic","title":"sub","abstract":[{"type":"text","text":"The Auth0 user identifier."}]}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"sections":[],"abstract":[{"text":"The Auth0 user identifier.","type":"text"}],"kind":"symbol","metadata":{"title":"sub","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sub","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth08UserInfoV3subSSvp","role":"symbol"},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"sub"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/sub"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/sub":{"url":"\/documentation\/auth0\/userinfo\/sub","kind":"symbol","title":"sub","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"sub"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","type":"topic","abstract":[{"type":"text","text":"The Auth0 user identifier."}],"role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/updatedat.json b/docs/data/documentation/auth0/userinfo/updatedat.json index fa5dead3..84c5be1b 100644 --- a/docs/data/documentation/auth0/userinfo/updatedat.json +++ b/docs/data/documentation/auth0/userinfo/updatedat.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"externalID":"s:5Auth08UserInfoV9updatedAt10Foundation4DateVSgvp","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"updatedAt","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"},{"text":"?","kind":"text"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"updatedAt","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"style":"note","type":"aside","name":"Requires","content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}],"type":"paragraph"}]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/updatedat"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"The date and time the user’s information was last updated.","type":"text"}],"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/updatedAt":{"abstract":[{"type":"text","text":"The date and time the user’s information was last updated."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"updatedAt","url":"\/documentation\/auth0\/userinfo\/updatedat","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"text":"The date and time the user’s information was last updated.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"updatedAt"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":"?"}]}]},{"content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"type":"aside","style":"note","name":"Requires","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/updatedat"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"title":"updatedAt","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"updatedAt","kind":"identifier"},{"kind":"text","text":": "},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"externalID":"s:5Auth08UserInfoV9updatedAt10Foundation4DateVSgvp","roleHeading":"Instance Property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/updatedAt":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","url":"\/documentation\/auth0\/userinfo\/updatedat","role":"symbol","abstract":[{"type":"text","text":"The date and time the user’s information was last updated."}],"title":"updatedAt","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"updatedAt","kind":"identifier"},{"kind":"text","text":": "},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/website.json b/docs/data/documentation/auth0/userinfo/website.json index 6a642498..1ecaf267 100644 --- a/docs/data/documentation/auth0/userinfo/website.json +++ b/docs/data/documentation/auth0/userinfo/website.json @@ -1 +1 @@ -{"abstract":[{"text":"The URL of the user’s website.","type":"text"}],"sections":[],"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"website","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"symbolKind":"property","roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth08UserInfoV7website10Foundation3URLVSgvp","modules":[{"name":"Auth0"}],"title":"website"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/website"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"website"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"name":"Requires","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/website":{"abstract":[{"type":"text","text":"The URL of the user’s website."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"website"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"website","url":"\/documentation\/auth0\/userinfo\/website","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website"},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"type":"text","text":"The URL of the user’s website."}],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV7website10Foundation3URLVSgvp","symbolKind":"property","title":"website","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"website"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","role":"symbol"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/website"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"website"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}],"style":"note"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/website":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","title":"website","abstract":[{"type":"text","text":"The URL of the user’s website."}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"website","kind":"identifier"},{"kind":"text","text":": "},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/website"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/zoneinfo.json b/docs/data/documentation/auth0/userinfo/zoneinfo.json index 447b59e5..de118b9c 100644 --- a/docs/data/documentation/auth0/userinfo/zoneinfo.json +++ b/docs/data/documentation/auth0/userinfo/zoneinfo.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"zoneinfo"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation8TimeZoneV","kind":"typeIdentifier","text":"TimeZone"},{"text":"?","kind":"text"}],"externalID":"s:5Auth08UserInfoV8zoneinfo10Foundation8TimeZoneVSgvp","symbolKind":"property","title":"zoneinfo","modules":[{"name":"Auth0"}],"role":"symbol"},"abstract":[{"text":"The time zone of the user.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"zoneinfo","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation8TimeZoneV","text":"TimeZone","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}],"type":"aside","style":"note","name":"Requires"}]}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/zoneinfo"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/zoneinfo":{"abstract":[{"text":"The time zone of the user.","type":"text"}],"title":"zoneinfo","role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/userinfo\/zoneinfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"zoneinfo","kind":"identifier"},{"kind":"text","text":": "},{"text":"TimeZone","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation8TimeZoneV"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"roleHeading":"Instance Property","title":"zoneinfo","externalID":"s:5Auth08UserInfoV8zoneinfo10Foundation8TimeZoneVSgvp","symbolKind":"property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"zoneinfo"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation8TimeZoneV","kind":"typeIdentifier","text":"TimeZone"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"zoneinfo","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation8TimeZoneV","kind":"typeIdentifier","text":"TimeZone"},{"text":"?","kind":"text"}]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"type":"aside","style":"note","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}]}],"kind":"content"}],"abstract":[{"text":"The time zone of the user.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/zoneinfo"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/zoneinfo":{"url":"\/documentation\/auth0\/userinfo\/zoneinfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo","title":"zoneinfo","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"The time zone of the user."}],"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"zoneinfo","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation8TimeZoneV","text":"TimeZone","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userpatchattributes.json b/docs/data/documentation/auth0/userpatchattributes.json index 9022d210..ec3f39e5 100644 --- a/docs/data/documentation/auth0/userpatchattributes.json +++ b/docs/data/documentation/auth0/userpatchattributes.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"metadata":{"symbolKind":"class","externalID":"s:5Auth019UserPatchAttributesC","role":"symbol","roleHeading":"Class","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"title":"UserPatchAttributes"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"final","kind":"keyword"},{"kind":"text","text":" "},{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserPatchAttributes","kind":"identifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"type":"text","text":" method of "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true},{"text":".","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","interfaceLanguage":"swift"},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)"],"title":"Instance Methods"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/userMetadata(_:)":{"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userMetadata","kind":"identifier"},{"kind":"text","text":"(["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"abstract":[{"text":"Update user metadata.","type":"text"}],"title":"userMetadata(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/username(_:connection:)":{"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"abstract":[{"text":"Change the username.","type":"text"}],"deprecated":true,"title":"username(_:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneVerified(_:connection:)":{"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"phoneVerified","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"abstract":[{"text":"Set the verified status of the phone number.","type":"text"}],"deprecated":true,"title":"phoneVerified(_:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference"},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/email(_:verified:verify:connection:clientId:)":{"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"verified","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"abstract":[{"text":"Change the email of the user.","type":"text"}],"deprecated":true,"title":"email(_:verified:verify:connection:clientId:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneNumber(_:verified:verify:connection:clientId:)":{"abstract":[{"text":"Change the phone number of the user (SMS connection only).","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"phoneNumber","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"verified"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"title":"phoneNumber(_:verified:verify:connection:clientId:)","url":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)","role":"symbol","deprecated":true,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/blocked(_:)":{"abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"blocked","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"title":"blocked(_:)","url":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","role":"symbol","deprecated":true,"kind":"symbol"},"https://auth0.com/docs/api/management/v2":{"type":"link","titleInlineContent":[{"type":"text","text":"Management API v2"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/appMetadata(_:)":{"abstract":[{"type":"text","text":"Update app metadata."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"appMetadata"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"title":"appMetadata(_:)","url":"\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)","role":"symbol","deprecated":true,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/password(_:verify:connection:)":{"abstract":[{"text":"Change the user’s password.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"password","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?, "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"title":"password(_:verify:connection:)","url":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)","role":"symbol","deprecated":true,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/emailVerified(_:connection:)":{"abstract":[{"type":"text","text":"Set the verified status of the email."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"title":"emailVerified(_:connection:)","url":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","role":"symbol","deprecated":true,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/init(dictionary:)":{"abstract":[{"text":"Creates a new ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","type":"topic","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"dictionary"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"title":"init(dictionary:)","url":"\/documentation\/auth0\/userpatchattributes\/init(dictionary:)","role":"symbol","kind":"symbol"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"kind":"symbol","metadata":{"symbolKind":"class","modules":[{"name":"Auth0"}],"fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"roleHeading":"Class","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"role":"symbol","title":"UserPatchAttributes","externalID":"s:5Auth019UserPatchAttributesC"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)"]},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)"]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"final","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/username(_:connection:)":{"deprecated":true,"abstract":[{"text":"Change the username.","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","title":"username(_:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/appMetadata(_:)":{"url":"\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)","title":"appMetadata(_:)","abstract":[{"text":"Update app metadata.","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"appMetadata","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/init(dictionary:)":{"abstract":[{"type":"text","text":"Creates a new "},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance."}],"title":"init(dictionary:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"dictionary","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","type":"topic","url":"\/documentation\/auth0\/userpatchattributes\/init(dictionary:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"text":" method of ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/email(_:verified:verify:connection:clientId:)":{"deprecated":true,"abstract":[{"type":"text","text":"Change the email of the user."}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"email","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"verified","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"text":"verify","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","title":"email(_:verified:verify:connection:clientId:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/blocked(_:)":{"type":"topic","role":"symbol","abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"blocked","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","deprecated":true,"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","title":"blocked(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneVerified(_:connection:)":{"deprecated":true,"abstract":[{"type":"text","text":"Set the verified status of the phone number."}],"type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"phoneVerified","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","title":"phoneVerified(_:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/userMetadata(_:)":{"abstract":[{"text":"Update user metadata.","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userMetadata"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"url":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","title":"userMetadata(_:)"},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","titleInlineContent":[{"text":"Management API v2","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneNumber(_:verified:verify:connection:clientId:)":{"deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","title":"phoneNumber(_:verified:verify:connection:clientId:)","role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)","abstract":[{"text":"Change the phone number of the user (SMS connection only).","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"phoneNumber","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"verified","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?, "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/password(_:verify:connection:)":{"deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","title":"password(_:verify:connection:)","role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)","abstract":[{"text":"Change the user’s password.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"password"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/emailVerified(_:connection:)":{"deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","title":"emailVerified(_:connection:)","role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","abstract":[{"type":"text","text":"Set the verified status of the email."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"emailVerified"},{"kind":"text","text":"("},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userpatchattributes/appmetadata(_:).json b/docs/data/documentation/auth0/userpatchattributes/appmetadata(_:).json index c5d24e05..fa2d47a6 100644 --- a/docs/data/documentation/auth0/userpatchattributes/appmetadata(_:).json +++ b/docs/data/documentation/auth0/userpatchattributes/appmetadata(_:).json @@ -1 +1 @@ -{"metadata":{"symbolKind":"method","platforms":[],"title":"appMetadata(_:)","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth019UserPatchAttributesC11appMetadatayACSDySSypGF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"appMetadata"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"roleHeading":"Instance Method"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"appMetadata","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"metadata"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","text":"UserPatchAttributes"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"metadata","content":[{"inlineContent":[{"type":"text","text":"New app metadata values."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}]}]}],"deprecationSummary":[{"inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}],"type":"paragraph"}],"abstract":[{"type":"text","text":"Update app metadata."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/appMetadata(_:)":{"abstract":[{"type":"text","text":"Update app metadata."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"appMetadata"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"title":"appMetadata(_:)","url":"\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)","role":"symbol","deprecated":true,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference"},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","role":"symbol","type":"topic"}}} \ No newline at end of file +{"deprecationSummary":[{"inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}],"type":"paragraph"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"appMetadata"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"metadata"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"New app metadata values."}]}],"name":"metadata"}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"title":"appMetadata(_:)","roleHeading":"Instance Method","externalID":"s:5Auth019UserPatchAttributesC11appMetadatayACSDySSypGF","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"appMetadata","kind":"identifier"},{"kind":"text","text":"(["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"platforms":[],"role":"symbol","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"abstract":[{"text":"Update app metadata.","type":"text"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/appMetadata(_:)":{"url":"\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)","title":"appMetadata(_:)","abstract":[{"text":"Update app metadata.","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"appMetadata","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"text":" method of ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userpatchattributes/blocked(_:).json b/docs/data/documentation/auth0/userpatchattributes/blocked(_:).json index e9568f4d..e82054f1 100644 --- a/docs/data/documentation/auth0/userpatchattributes/blocked(_:).json +++ b/docs/data/documentation/auth0/userpatchattributes/blocked(_:).json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"roleHeading":"Instance Method","externalID":"s:5Auth019UserPatchAttributesC7blockedyACSbF","platforms":[],"role":"symbol","title":"blocked(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"blocked"},{"kind":"text","text":"("},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"modules":[{"name":"Auth0"}],"symbolKind":"method"},"abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"blocked"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"blocked","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"If the user is blocked.","type":"text"}],"type":"paragraph"}],"name":"blocked"}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/blocked(_:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)"},"kind":"symbol","deprecationSummary":[{"inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}],"type":"paragraph"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference"},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/blocked(_:)":{"abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"blocked","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"title":"blocked(_:)","url":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","role":"symbol","deprecated":true,"kind":"symbol"}}} \ No newline at end of file +{"sections":[],"metadata":{"roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"blocked"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"platforms":[],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth019UserPatchAttributesC7blockedyACSbF","symbolKind":"method","title":"blocked(_:)"},"kind":"symbol","abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"blocked","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"blocked"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"If the user is blocked."}],"type":"paragraph"}],"name":"blocked"}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}]}]}],"deprecationSummary":[{"inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}],"type":"paragraph"}],"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/blocked(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/blocked(_:)":{"type":"topic","role":"symbol","abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"blocked","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","deprecated":true,"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","title":"blocked(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"text":" method of ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userpatchattributes/email(_:verified:verify:connection:clientid:).json b/docs/data/documentation/auth0/userpatchattributes/email(_:verified:verify:connection:clientid:).json index 8f124491..2839adf7 100644 --- a/docs/data/documentation/auth0/userpatchattributes/email(_:verified:verify:connection:clientid:).json +++ b/docs/data/documentation/auth0/userpatchattributes/email(_:verified:verify:connection:clientid:).json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"metadata":{"roleHeading":"Instance Method","role":"symbol","title":"email(_:verified:verify:connection:clientId:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019UserPatchAttributesC5email_8verified6verify10connection8clientIdACSS_SbSgAIS2StF","symbolKind":"method","platforms":[],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"email"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}]},"abstract":[{"type":"text","text":"Change the email of the user."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"email","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"email","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"verified","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"? = nil, "},{"text":"verify","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"? = nil, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"New email for the user.","type":"text"}]}],"name":"email"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the email is verified."}]}],"name":"verified"},{"content":[{"inlineContent":[{"type":"text","text":"If the user should verify the email."}],"type":"paragraph"}],"name":"verify"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}],"name":"connection"},{"content":[{"inlineContent":[{"type":"text","text":"Auth0 Client ID."}],"type":"paragraph"}],"name":"clientId"}]},{"content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference"},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/email(_:verified:verify:connection:clientId:)":{"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"verified","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"abstract":[{"text":"Change the email of the user.","type":"text"}],"deprecated":true,"title":"email(_:verified:verify:connection:clientId:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","type":"topic","kind":"symbol"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Change the email of the user."}],"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"email","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"verified"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"? = nil, "},{"text":"verify","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"}]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"New email for the user."}]}],"name":"email"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the email is verified."}]}],"name":"verified"},{"content":[{"type":"paragraph","inlineContent":[{"text":"If the user should verify the email.","type":"text"}]}],"name":"verify"},{"name":"connection","content":[{"inlineContent":[{"text":"Name of the connection.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"Auth0 Client ID.","type":"text"}],"type":"paragraph"}],"name":"clientId"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"sections":[],"metadata":{"title":"email(_:verified:verify:connection:clientId:)","externalID":"s:5Auth019UserPatchAttributesC5email_8verified6verify10connection8clientIdACSS_SbSgAIS2StF","modules":[{"name":"Auth0"}],"platforms":[],"role":"symbol","symbolKind":"method","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"verified","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"text":" method of ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/email(_:verified:verify:connection:clientId:)":{"deprecated":true,"abstract":[{"type":"text","text":"Change the email of the user."}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"email","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"verified","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"text":"verify","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","title":"email(_:verified:verify:connection:clientId:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userpatchattributes/emailverified(_:connection:).json b/docs/data/documentation/auth0/userpatchattributes/emailverified(_:connection:).json index 93619cae..f4df0bd4 100644 --- a/docs/data/documentation/auth0/userpatchattributes/emailverified(_:connection:).json +++ b/docs/data/documentation/auth0/userpatchattributes/emailverified(_:connection:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"verified","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"verified","content":[{"type":"paragraph","inlineContent":[{"text":"If the email is verified.","type":"text"}]}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"UserPatchAttributes"},{"text":" instance to allow method chaining.","type":"text"}]}],"kind":"content"}],"kind":"symbol","metadata":{"externalID":"s:5Auth019UserPatchAttributesC13emailVerified_10connectionACSb_SStF","roleHeading":"Instance Method","platforms":[],"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"emailVerified"},{"text":"(","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"emailVerified(_:connection:)"},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)"]}],"sections":[],"abstract":[{"text":"Set the verified status of the email.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/emailVerified(_:connection:)":{"abstract":[{"type":"text","text":"Set the verified status of the email."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"title":"emailVerified(_:connection:)","url":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","role":"symbol","deprecated":true,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference"},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","role":"symbol","type":"topic"}}} \ No newline at end of file +{"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"emailVerified","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"symbolKind":"method","platforms":[],"externalID":"s:5Auth019UserPatchAttributesC13emailVerified_10connectionACSb_SStF","roleHeading":"Instance Method","title":"emailVerified(_:connection:)"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Set the verified status of the email."}],"deprecationSummary":[{"inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}],"type":"paragraph"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"emailVerified","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"verified","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the email is verified."}]}],"name":"verified"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}],"name":"connection"}]},{"content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"text":" method of ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/emailVerified(_:connection:)":{"deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","title":"emailVerified(_:connection:)","role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","abstract":[{"type":"text","text":"Set the verified status of the email."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"emailVerified"},{"kind":"text","text":"("},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userpatchattributes/init(dictionary:).json b/docs/data/documentation/auth0/userpatchattributes/init(dictionary:).json index d38910e9..e86c90e5 100644 --- a/docs/data/documentation/auth0/userpatchattributes/init(dictionary:).json +++ b/docs/data/documentation/auth0/userpatchattributes/init(dictionary:).json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"abstract":[{"text":"Creates a new ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"text":"dictionary","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"] = [:])","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Default attribute values."}]}],"name":"dictionary"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)"},"metadata":{"title":"init(dictionary:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"dictionary","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"externalID":"s:5Auth019UserPatchAttributesC10dictionaryACSDySSypG_tcfc","roleHeading":"Initializer","symbolKind":"init","role":"symbol","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/init(dictionary:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference"},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/init(dictionary:)":{"abstract":[{"text":"Creates a new ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","type":"topic","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"dictionary"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"title":"init(dictionary:)","url":"\/documentation\/auth0\/userpatchattributes\/init(dictionary:)","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"dictionary"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"] = [:])","kind":"text"}]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Default attribute values.","type":"text"}]}],"name":"dictionary"}],"kind":"parameters"}],"kind":"symbol","metadata":{"title":"init(dictionary:)","symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"dictionary","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth019UserPatchAttributesC10dictionaryACSDySSypG_tcfc","roleHeading":"Initializer"},"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/init(dictionary:)"]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/init(dictionary:)":{"abstract":[{"type":"text","text":"Creates a new "},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance."}],"title":"init(dictionary:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"dictionary","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"])"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","type":"topic","url":"\/documentation\/auth0\/userpatchattributes\/init(dictionary:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"text":" method of ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userpatchattributes/password(_:verify:connection:).json b/docs/data/documentation/auth0/userpatchattributes/password(_:verify:connection:).json index af333d38..1e362cce 100644 --- a/docs/data/documentation/auth0/userpatchattributes/password(_:verify:connection:).json +++ b/docs/data/documentation/auth0/userpatchattributes/password(_:verify:connection:).json @@ -1 +1 @@ -{"metadata":{"roleHeading":"Instance Method","platforms":[],"modules":[{"name":"Auth0"}],"title":"password(_:verify:connection:)","symbolKind":"method","role":"symbol","externalID":"s:5Auth019UserPatchAttributesC8password_6verify10connectionACSS_SbSgSStF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"password","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?, "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"kind":"symbol","sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Change the user’s password."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"password"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"password","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":"? = nil, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"New password for the user.","type":"text"}]}],"name":"password"},{"name":"verify","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the password should be verified by the user."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the connection.","type":"text"}]}],"name":"connection"}]},{"content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"UserPatchAttributes"},{"text":" instance to allow method chaining.","type":"text"}]}],"kind":"content"}],"deprecationSummary":[{"inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}],"type":"paragraph"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/password(_:verify:connection:)":{"abstract":[{"text":"Change the user’s password.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"password","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?, "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"title":"password(_:verify:connection:)","url":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)","role":"symbol","deprecated":true,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference"},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)"]}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"password"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"title":"password(_:verify:connection:)","symbolKind":"method","platforms":[],"externalID":"s:5Auth019UserPatchAttributesC8password_6verify10connectionACSS_SbSgSStF"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Change the user’s password."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"password","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"password","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":"? = nil, "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"password","content":[{"type":"paragraph","inlineContent":[{"text":"New password for the user.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the password should be verified by the user."}]}],"name":"verify"},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"text":"Name of the connection.","type":"text"}]}]}],"kind":"parameters"},{"content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}],"kind":"content"}],"deprecationSummary":[{"inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}],"type":"paragraph"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/password(_:verify:connection:)":{"deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","title":"password(_:verify:connection:)","role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)","abstract":[{"text":"Change the user’s password.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"password"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"text":" method of ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userpatchattributes/phonenumber(_:verified:verify:connection:clientid:).json b/docs/data/documentation/auth0/userpatchattributes/phonenumber(_:verified:verify:connection:clientid:).json index ae75b82e..3222718e 100644 --- a/docs/data/documentation/auth0/userpatchattributes/phonenumber(_:verified:verify:connection:clientid:).json +++ b/docs/data/documentation/auth0/userpatchattributes/phonenumber(_:verified:verify:connection:clientid:).json @@ -1 +1 @@ -{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"abstract":[{"text":"Change the phone number of the user (SMS connection only).","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"verified"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"New phone number for the user.","type":"text"}],"type":"paragraph"}],"name":"phoneNumber"},{"name":"verified","content":[{"type":"paragraph","inlineContent":[{"text":"If the phone number is verified.","type":"text"}]}]},{"name":"verify","content":[{"type":"paragraph","inlineContent":[{"text":"If the user should verify the phone number.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}],"name":"connection"},{"name":"clientId","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0 Client ID."}]}]}]},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"metadata":{"roleHeading":"Instance Method","title":"phoneNumber(_:verified:verify:connection:clientId:)","modules":[{"name":"Auth0"}],"symbolKind":"method","externalID":"s:5Auth019UserPatchAttributesC11phoneNumber_8verified6verify10connection8clientIdACSS_SbSgAIS2StF","role":"symbol","platforms":[],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"verified","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?, "},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}]},"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference"},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneNumber(_:verified:verify:connection:clientId:)":{"abstract":[{"text":"Change the phone number of the user (SMS connection only).","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"phoneNumber","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"verified"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"title":"phoneNumber(_:verified:verify:connection:clientId:)","url":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)","role":"symbol","deprecated":true,"kind":"symbol"}}} \ No newline at end of file +{"deprecationSummary":[{"inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}],"type":"paragraph"}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"phoneNumber"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"externalID":"s:5Auth019UserPatchAttributesC11phoneNumber_8verified6verify10connection8clientIdACSS_SbSgAIS2StF","platforms":[],"roleHeading":"Instance Method","role":"symbol","title":"phoneNumber(_:verified:verify:connection:clientId:)","modules":[{"name":"Auth0"}],"symbolKind":"method"},"abstract":[{"text":"Change the phone number of the user (SMS connection only).","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"verified","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"verify","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"New phone number for the user."}]}],"name":"phoneNumber"},{"name":"verified","content":[{"type":"paragraph","inlineContent":[{"text":"If the phone number is verified.","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"If the user should verify the phone number."}],"type":"paragraph"}],"name":"verify"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the connection.","type":"text"}]}],"name":"connection"},{"content":[{"inlineContent":[{"type":"text","text":"Auth0 Client ID."}],"type":"paragraph"}],"name":"clientId"}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"UserPatchAttributes"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"text":" method of ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneNumber(_:verified:verify:connection:clientId:)":{"deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","title":"phoneNumber(_:verified:verify:connection:clientId:)","role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)","abstract":[{"text":"Change the phone number of the user (SMS connection only).","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"phoneNumber","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"verified","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?, "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userpatchattributes/phoneverified(_:connection:).json b/docs/data/documentation/auth0/userpatchattributes/phoneverified(_:connection:).json index f38b95fa..241dac99 100644 --- a/docs/data/documentation/auth0/userpatchattributes/phoneverified(_:connection:).json +++ b/docs/data/documentation/auth0/userpatchattributes/phoneverified(_:connection:).json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"abstract":[{"type":"text","text":"Set the verified status of the phone number."}],"metadata":{"externalID":"s:5Auth019UserPatchAttributesC13phoneVerified_10connectionACSb_SStF","title":"phoneVerified(_:connection:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"phoneVerified","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"platforms":[],"roleHeading":"Instance Method","symbolKind":"method"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"phoneVerified"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"verified","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","text":"UserPatchAttributes"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"If the phone number is verified or not."}],"type":"paragraph"}],"name":"verified"},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}]}]},{"content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneVerified(_:connection:)":{"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"phoneVerified","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"abstract":[{"text":"Set the verified status of the phone number.","type":"text"}],"deprecated":true,"title":"phoneVerified(_:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference"},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"deprecationSummary":[{"inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}],"type":"paragraph"}],"abstract":[{"type":"text","text":"Set the verified status of the phone number."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)"]}],"sections":[],"metadata":{"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth019UserPatchAttributesC13phoneVerified_10connectionACSb_SStF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneVerified","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"title":"phoneVerified(_:connection:)","platforms":[],"role":"symbol","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneVerified"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"verified","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","text":"UserPatchAttributes"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"verified","content":[{"type":"paragraph","inlineContent":[{"text":"If the phone number is verified or not.","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Name of the connection."}],"type":"paragraph"}],"name":"connection"}]},{"kind":"content","content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"text":" method of ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneVerified(_:connection:)":{"deprecated":true,"abstract":[{"type":"text","text":"Set the verified status of the phone number."}],"type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"phoneVerified","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"url":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","title":"phoneVerified(_:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userpatchattributes/usermetadata(_:).json b/docs/data/documentation/auth0/userpatchattributes/usermetadata(_:).json index 9ce82d6d..ade0ef5e 100644 --- a/docs/data/documentation/auth0/userpatchattributes/usermetadata(_:).json +++ b/docs/data/documentation/auth0/userpatchattributes/usermetadata(_:).json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"userMetadata","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"metadata"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"New user metadata values.","type":"text"}]}],"name":"metadata"}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)"]}],"abstract":[{"type":"text","text":"Update user metadata."}],"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth019UserPatchAttributesC12userMetadatayACSDySSypGF","role":"symbol","title":"userMetadata(_:)","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"userMetadata"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/userMetadata(_:)":{"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userMetadata","kind":"identifier"},{"kind":"text","text":"(["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"abstract":[{"text":"Update user metadata.","type":"text"}],"title":"userMetadata(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference"},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"}}} \ No newline at end of file +{"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"userMetadata"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]) -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"roleHeading":"Instance Method","symbolKind":"method","externalID":"s:5Auth019UserPatchAttributesC12userMetadatayACSDySSypGF","modules":[{"name":"Auth0"}],"role":"symbol","title":"userMetadata(_:)"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"abstract":[{"type":"text","text":"Update user metadata."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"userMetadata"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"metadata","kind":"internalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"metadata","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"New user metadata values."}]}]}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/userMetadata(_:)":{"abstract":[{"text":"Update user metadata.","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userMetadata"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"url":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","title":"userMetadata(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"text":" method of ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userpatchattributes/username(_:connection:).json b/docs/data/documentation/auth0/userpatchattributes/username(_:connection:).json index c3836a52..a4b761fb 100644 --- a/docs/data/documentation/auth0/userpatchattributes/username(_:connection:).json +++ b/docs/data/documentation/auth0/userpatchattributes/username(_:connection:).json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"metadata":{"title":"username(_:connection:)","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"platforms":[],"externalID":"s:5Auth019UserPatchAttributesC8username_10connectionACSS_SStF","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"role":"symbol"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"username"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"username"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"New username for the user.","type":"text"}]}],"name":"username"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the connection.","type":"text"}]}],"name":"connection"}]},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}]}],"sections":[],"deprecationSummary":[{"inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}],"type":"paragraph"}],"abstract":[{"type":"text","text":"Change the username."}],"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/username(_:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/username(_:connection:)":{"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"abstract":[{"text":"Change the username.","type":"text"}],"deprecated":true,"title":"username(_:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference"},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","role":"symbol","type":"topic"}}} \ No newline at end of file +{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/username(_:connection:)"]}],"metadata":{"role":"symbol","platforms":[],"roleHeading":"Instance Method","title":"username(_:connection:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019UserPatchAttributesC8username_10connectionACSS_SStF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"username"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"symbolKind":"method"},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"username"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"username","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"UserPatchAttributes","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"New username for the user.","type":"text"}]}],"name":"username"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}],"name":"connection"}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"abstract":[{"type":"text","text":"Change the username."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"text":" method of ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/username(_:connection:)":{"deprecated":true,"abstract":[{"text":"Change the username.","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","title":"username(_:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users(token:domain:session:).json b/docs/data/documentation/auth0/users(token:domain:session:).json index 8848d2df..ba0ef99d 100644 --- a/docs/data/documentation/auth0/users(token:domain:session:).json +++ b/docs/data/documentation/auth0/users(token:domain:session:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","interfaceLanguage":"swift"},"metadata":{"title":"users(token:domain:session:)","symbolKind":"func","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Users","preciseIdentifier":"s:5Auth05UsersP"}],"externalID":"s:5Auth05users5token6domain7sessionAA5Users_pSS_SSSo12NSURLSessionCtF","role":"symbol","roleHeading":"Function"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users(token:domain:session:)"]}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"type":"text","text":" client to perform operations with the Users"},{"type":"text","text":" "},{"type":"text","text":"endpoints."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"users"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"token"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":" = .shared) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP","text":"Users"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"token","content":[{"inlineContent":[{"text":"Management API token with the correct allowed scopes to perform the desired action.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Domain of your Auth0 account, for example "},{"type":"codeVoice","code":"samples.us.auth0.com"},{"type":"text","text":"."}]}],"name":"domain"},{"name":"session","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"code":"URLSession","type":"codeVoice"},{"text":" instance used for networking. Defaults to ","type":"text"},{"type":"codeVoice","code":"URLSession.shared"},{"type":"text","text":"."}]}]}]},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0 Management API v2 client."}]}],"kind":"content"},{"kind":"content","content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"syntax":"swift","type":"codeListing","code":["Auth0.users(token: credentials.accessToken, domain: \"samples.us.auth0.com\")"]},{"inlineContent":[{"text":"You can only perform the following operations:","type":"text"}],"type":"paragraph"},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"text":"Get a user by ID","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Update the user’s "},{"type":"codeVoice","code":"user_metadata"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Link users"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Unlink users"}]}]}]}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"type":"text","text":"Management API v2"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:domain:session:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":") -> ","kind":"text"},{"text":"Users","kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP"}],"abstract":[{"text":"Auth0 ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"type":"text","text":" client to perform operations with the Users"},{"text":" ","type":"text"},{"type":"text","text":"endpoints."}],"url":"\/documentation\/auth0\/users(token:domain:session:)","title":"users(token:domain:session:)","role":"symbol","type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"Auth0 "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference"},{"type":"text","text":" client to perform operations with the Users"},{"type":"text","text":" "},{"text":"endpoints.","type":"text"}],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":") -> ","kind":"text"},{"text":"Users","kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP"}],"role":"symbol","externalID":"s:5Auth05users5token6domain7sessionAA5Users_pSS_SSSo12NSURLSessionCtF","title":"users(token:domain:session:)","roleHeading":"Function","modules":[{"name":"Auth0"}],"symbolKind":"func"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)"},"variants":[{"paths":["\/documentation\/auth0\/users(token:domain:session:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":" = .shared) -> "},{"text":"Users","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","preciseIdentifier":"s:5Auth05UsersP"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"token","content":[{"inlineContent":[{"type":"text","text":"Management API token with the correct allowed scopes to perform the desired action."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Domain of your Auth0 account, for example "},{"type":"codeVoice","code":"samples.us.auth0.com"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"domain"},{"name":"session","content":[{"inlineContent":[{"type":"text","text":""},{"code":"URLSession","type":"codeVoice"},{"text":" instance used for networking. Defaults to ","type":"text"},{"code":"URLSession.shared","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"Auth0 Management API v2 client.","type":"text"}]}],"kind":"content"},{"kind":"content","content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"syntax":"swift","code":["Auth0.users(token: credentials.accessToken, domain: \"samples.us.auth0.com\")"],"type":"codeListing"},{"inlineContent":[{"text":"You can only perform the following operations:","type":"text"}],"type":"paragraph"},{"items":[{"content":[{"inlineContent":[{"text":"Get a user by ID","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Update the user’s ","type":"text"},{"type":"codeVoice","code":"user_metadata"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Link users","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Unlink users"}],"type":"paragraph"}]}],"type":"unorderedList"}]}],"kind":"symbol","references":{"https://auth0.com/docs/api/management/v2":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","titleInlineContent":[{"type":"text","text":"Management API v2"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:domain:session:)":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"domain","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth05UsersP","text":"Users","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/users(token:domain:session:)","title":"users(token:domain:session:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","abstract":[{"text":"Auth0 ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"type":"text","text":" client to perform operations with the Users"},{"type":"text","text":" "},{"text":"endpoints.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users(token:session:bundle:).json b/docs/data/documentation/auth0/users(token:session:bundle:).json index 2d665589..8eb0a473 100644 --- a/docs/data/documentation/auth0/users(token:session:bundle:).json +++ b/docs/data/documentation/auth0/users(token:session:bundle:).json @@ -1 +1 @@ -{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"kind":"text","text":"("},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":" = .shared, ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":" = .main) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","preciseIdentifier":"s:5Auth05UsersP","text":"Users","kind":"typeIdentifier"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"token","content":[{"inlineContent":[{"type":"text","text":"Management API token with the correct allowed scopes to perform the desired action."}],"type":"paragraph"}]},{"name":"session","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"URLSession"},{"type":"text","text":" instance used for networking. Defaults to "},{"type":"codeVoice","code":"URLSession.shared"},{"type":"text","text":"."}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Bundle used to locate the "},{"type":"codeVoice","code":"Auth0.plist"},{"type":"text","text":" file. Defaults to "},{"code":"Bundle.main","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"bundle"}]},{"content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0 Management API v2 client."}]}],"kind":"content"},{"kind":"content","content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"code":["Auth0.users(token: credentials.accessToken)"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can only perform the following operations:"}]},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Get a user by ID","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Update the user’s ","type":"text"},{"code":"user_metadata","type":"codeVoice"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Link users"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Unlink users","type":"text"}]}]}],"type":"unorderedList"},{"inlineContent":[{"text":"The Auth0 Domain is loaded from the ","type":"text"},{"type":"codeVoice","code":"Auth0.plist"},{"text":" file in your main bundle. It should have the following content:","type":"text"}],"type":"paragraph"},{"code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"],"syntax":"xml","type":"codeListing"},{"name":"Warning","content":[{"inlineContent":[{"type":"text","text":"Calling this method without a valid "},{"code":"Auth0.plist","type":"codeVoice"},{"type":"text","text":" file will crash your application."}],"type":"paragraph"}],"style":"warning","type":"aside"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"Auth0 "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference"},{"type":"text","text":" client to perform operations with the Users"},{"text":" ","type":"text"},{"text":"endpoints.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/users(token:session:bundle:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth05users5token7session6bundleAA5Users_pSS_So12NSURLSessionCSo8NSBundleCtF","roleHeading":"Function","symbolKind":"func","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"text":": ","kind":"text"},{"text":"Bundle","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP","text":"Users"}],"role":"symbol","title":"users(token:session:bundle:)","modules":[{"name":"Auth0"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:session:bundle:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"users","kind":"identifier"},{"kind":"text","text":"("},{"text":"token","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Users","preciseIdentifier":"s:5Auth05UsersP","kind":"typeIdentifier"}],"abstract":[{"text":"Auth0 ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"type":"text","text":" client to perform operations with the Users"},{"text":" ","type":"text"},{"type":"text","text":"endpoints."}],"url":"\/documentation\/auth0\/users(token:session:bundle:)","title":"users(token:session:bundle:)","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"text":"Management API v2","type":"text"}],"title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"kind":"text","text":"("},{"text":"token","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":" = .shared, ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"kind":"text","text":" = .main) -> "},{"preciseIdentifier":"s:5Auth05UsersP","text":"Users","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Management API token with the correct allowed scopes to perform the desired action."}],"type":"paragraph"}],"name":"token"},{"content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"},{"code":"URLSession","type":"codeVoice"},{"type":"text","text":" instance used for networking. Defaults to "},{"type":"codeVoice","code":"URLSession.shared"},{"type":"text","text":"."}]}],"name":"session"},{"name":"bundle","content":[{"inlineContent":[{"type":"text","text":"Bundle used to locate the "},{"type":"codeVoice","code":"Auth0.plist"},{"type":"text","text":" file. Defaults to "},{"type":"codeVoice","code":"Bundle.main"},{"text":".","type":"text"}],"type":"paragraph"}]}]},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0 Management API v2 client."}]}],"kind":"content"},{"kind":"content","content":[{"anchor":"Usage","level":2,"type":"heading","text":"Usage"},{"code":["Auth0.users(token: credentials.accessToken)"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"You can only perform the following operations:","type":"text"}]},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Get a user by ID"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Update the user’s "},{"type":"codeVoice","code":"user_metadata"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"Link users","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Unlink users"}]}]}],"type":"unorderedList"},{"type":"paragraph","inlineContent":[{"text":"The Auth0 Domain is loaded from the ","type":"text"},{"code":"Auth0.plist","type":"codeVoice"},{"type":"text","text":" file in your main bundle. It should have the following content:"}]},{"code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"],"type":"codeListing","syntax":"xml"},{"style":"warning","type":"aside","name":"Warning","content":[{"inlineContent":[{"type":"text","text":"Calling this method without a valid "},{"code":"Auth0.plist","type":"codeVoice"},{"type":"text","text":" file will crash your application."}],"type":"paragraph"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"users(token:session:bundle:)","roleHeading":"Function","externalID":"s:5Auth05users5token7session6bundleAA5Users_pSS_So12NSURLSessionCSo8NSBundleCtF","symbolKind":"func","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bundle","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Users","preciseIdentifier":"s:5Auth05UsersP"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users(token:session:bundle:)"]}],"kind":"symbol","abstract":[{"type":"text","text":"Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true,"type":"reference"},{"text":" client to perform operations with the Users","type":"text"},{"text":" ","type":"text"},{"text":"endpoints.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","titleInlineContent":[{"type":"text","text":"Management API v2"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:session:bundle:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":", "},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bundle","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth05UsersP","text":"Users","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/users(token:session:bundle:)","title":"users(token:session:bundle:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","abstract":[{"type":"text","text":"Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true,"type":"reference"},{"type":"text","text":" client to perform operations with the Users"},{"type":"text","text":" "},{"type":"text","text":"endpoints."}],"role":"symbol","type":"topic","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users.json b/docs/data/documentation/auth0/users.json index 8ce0c266..2872768a 100644 --- a/docs/data/documentation/auth0/users.json +++ b/docs/data/documentation/auth0/users.json @@ -1 +1 @@ -{"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)"],"title":"Instance Methods"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users"]}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"type":"inheritsFrom","kind":"relationships","title":"Inherits From"}],"kind":"symbol","sections":[],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"metadata":{"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","externalID":"s:5Auth05UsersP","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Users","kind":"identifier"}],"modules":[{"name":"Auth0"}],"roleHeading":"Protocol","symbolKind":"protocol"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"},{"kind":"text","text":" : "},{"text":"Loggable","preciseIdentifier":"s:5Auth08LoggableP","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},{"kind":"text","text":", "},{"text":"Trackable","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TrackableP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/url":{"type":"topic","role":"symbol","kind":"symbol","title":"url","url":"\/documentation\/auth0\/users\/url","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"url":"\/documentation\/auth0\/loggable","title":"Loggable","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:userMetadata:)":{"type":"topic","role":"symbol","kind":"symbol","title":"patch(_:userMetadata:)","url":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","abstract":[{"type":"text","text":"Updates only the user’s "},{"code":"user_metadata","type":"codeVoice"},{"text":" field.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withOtherUserToken:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"withOtherUserToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}],"abstract":[{"text":"Links a user given its identifier with a secondary user given its ID token.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"After this request the primary user will hold another identity in its "},{"code":"identities","type":"codeVoice"},{"type":"text","text":" attribute, which will represent"},{"text":" ","type":"text"},{"text":"the secondary user.","type":"text"}],"kind":"symbol","title":"link(_:withOtherUserToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","url":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-5y4yy":{"type":"topic","role":"symbol","kind":"symbol","title":"link(_:withUser:provider:connectionId:)","url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","defaultImplementations":1,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"title":"Trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-8mfww":{"type":"topic","role":"symbol","kind":"symbol","title":"get(_:fields:include:)","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","abstract":[{"text":"Fetches a user using its identifier.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","defaultImplementations":1,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"text":"include","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Users/token":{"type":"topic","role":"symbol","kind":"symbol","title":"token","url":"\/documentation\/auth0\/users\/token","abstract":[{"type":"text","text":"The Management API token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"token","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/unlink(identityId:provider:fromUserId:)":{"type":"topic","role":"symbol","kind":"symbol","title":"unlink(identityId:provider:fromUserId:)","url":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","abstract":[{"text":"Removes an identity from a user.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"unlink"},{"kind":"text","text":"("},{"text":"identityId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fromUserId"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":"], "},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"required":true},"https://auth0.com/docs/api/management/v2":{"type":"link","title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"type":"text","text":"Management API v2"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","interfaceLanguage":"swift"},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url"]},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)"]}],"relationshipsSections":[{"type":"inheritsFrom","kind":"relationships","title":"Inherits From","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]}],"metadata":{"externalID":"s:5Auth05UsersP","roleHeading":"Protocol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"symbolKind":"protocol","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","role":"symbol"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"},{"text":" : ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","preciseIdentifier":"s:5Auth08LoggableP","kind":"typeIdentifier","text":"Loggable"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","text":"Trackable","preciseIdentifier":"s:5Auth09TrackableP"}],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/users"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/unlink(identityId:provider:fromUserId:)":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"unlink","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"identityId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fromUserId"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","abstract":[{"type":"text","text":"Removes an identity from a user."}],"type":"topic","kind":"symbol","title":"unlink(identityId:provider:fromUserId:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:userMetadata:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"type":"topic","url":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","title":"patch(_:userMetadata:)","abstract":[{"type":"text","text":"Updates only the user’s "},{"type":"codeVoice","code":"user_metadata"},{"type":"text","text":" field."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-8mfww":{"role":"symbol","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","kind":"symbol","title":"get(_:fields:include:)","abstract":[{"type":"text","text":"Fetches a user using its identifier."}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"kind":"symbol","title":"Loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Loggable","kind":"identifier"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/loggable"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/trackable"},"doc://com.auth0.Auth0/documentation/Auth0/Users/url":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url","required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"type":"topic","url":"\/documentation\/auth0\/users\/url","title":"url","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","titleInlineContent":[{"type":"text","text":"Management API v2"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-5y4yy":{"title":"link(_:withUser:provider:connectionId:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","kind":"symbol","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"type":"topic","required":true,"role":"symbol","defaultImplementations":1,"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"withUser","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<["},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/token":{"role":"symbol","title":"token","abstract":[{"type":"text","text":"The Management API token."}],"kind":"symbol","type":"topic","required":true,"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"token"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/users\/token","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withOtherUserToken:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"withOtherUserToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<["},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","title":"link(_:withOtherUserToken:)","kind":"symbol","required":true,"abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its ID token."},{"type":"text","text":" "},{"text":"After this request the primary user will hold another identity in its ","type":"text"},{"type":"codeVoice","code":"identities"},{"text":" attribute, which will represent","type":"text"},{"type":"text","text":" "},{"text":"the secondary user.","type":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users/get(_:fields:include:)-7aaln.json b/docs/data/documentation/auth0/users/get(_:fields:include:)-7aaln.json index 0d1a6d7a..09e767ce 100644 --- a/docs/data/documentation/auth0/users/get(_:fields:include:)-7aaln.json +++ b/docs/data/documentation/auth0/users/get(_:fields:include:)-7aaln.json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fields"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"] = [], "},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":" = true) -> "},{"kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the user. You can get this value from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the user’s ID token, or from the "},{"code":"sub","type":"codeVoice"},{"type":"text","text":" property of a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true},{"text":" instance.","type":"text"}]}],"name":"identifier"},{"content":[{"inlineContent":[{"type":"text","text":"List of the user’s field names that will be included\/excluded in the response. By default all will be retrieved."}],"type":"paragraph"}],"name":"fields"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Flag that indicates that only the names in ‘fields’ should be included\/excluded in the response. By default it will include them."}]}],"name":"include"}]},{"content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield a user.","type":"text"}]}],"kind":"content"},{"kind":"content","content":[{"anchor":"Usage","level":2,"type":"heading","text":"Usage"},{"type":"paragraph","inlineContent":[{"text":"By default it gets all the user’s attributes:","type":"text"}]},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\")"," .start { result in"," switch result {"," case .success(let user):"," print(\"Obtained user: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"You can select which attributes you want:","type":"text"}]},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"email\", \"user_id\"])"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"You can even exclude some attributes:"}],"type":"paragraph"},{"type":"codeListing","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"identities\", \"app_metadata\"], include: false)"," .start { print($0) }"],"syntax":"swift"},{"type":"aside","name":"Requires","style":"note","content":[{"inlineContent":[{"text":"The token must have the scope ","type":"text"},{"code":"read:users","type":"codeVoice"},{"type":"text","text":" scope."}],"type":"paragraph"}]}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fields"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"include"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth05UsersPAAE3get_6fields7includeAA7RequestVySDySSypGAA15ManagementErrorVGSS_SaySSGSbtF","title":"get(_:fields:include:)","extendedModule":"Auth0"},"variants":[{"paths":["\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id":{"title":"Management API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject","title":"ManagementObject","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"text":"Management API v2","type":"text"}],"type":"link","title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-7aaln":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"include"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"type":"topic","title":"get(_:fields:include:)","abstract":[{"text":"Fetches a user using its identifier.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-8mfww":{"type":"topic","role":"symbol","kind":"symbol","title":"get(_:fields:include:)","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","abstract":[{"text":"Fetches a user using its identifier.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","defaultImplementations":1,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"text":"include","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"required":true}}} \ No newline at end of file +{"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"],"title":"Related Documentation"}],"metadata":{"symbolKind":"method","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"title":"get(_:fields:include:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"get","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"], ","kind":"text"},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth05UsersPAAE3get_6fields7includeAA7RequestVySDySSypGAA15ManagementErrorVGSS_SaySSGSbtF"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"] = [], ","kind":"text"},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":" = true) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"identifier","content":[{"inlineContent":[{"type":"text","text":"ID of the user. You can get this value from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the user’s ID token, or from the "},{"code":"sub","type":"codeVoice"},{"type":"text","text":" property of a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"type":"text","text":" instance."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"List of the user’s field names that will be included\/excluded in the response. By default all will be retrieved.","type":"text"}]}],"name":"fields"},{"name":"include","content":[{"inlineContent":[{"type":"text","text":"Flag that indicates that only the names in ‘fields’ should be included\/excluded in the response. By default it will include them."}],"type":"paragraph"}]}]},{"content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"inlineContent":[{"text":"A request that will yield a user.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"inlineContent":[{"text":"By default it gets all the user’s attributes:","type":"text"}],"type":"paragraph"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\")"," .start { result in"," switch result {"," case .success(let user):"," print(\"Obtained user: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can select which attributes you want:"}]},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"email\", \"user_id\"])"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can even exclude some attributes:"}]},{"syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"identities\", \"app_metadata\"], include: false)"," .start { print($0) }"],"type":"codeListing"},{"type":"aside","name":"Requires","style":"note","content":[{"inlineContent":[{"type":"text","text":"The token must have the scope "},{"type":"codeVoice","code":"read:users"},{"type":"text","text":" scope."}],"type":"paragraph"}]}],"kind":"content"}],"sections":[],"abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-7aaln":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","kind":"symbol","role":"symbol","title":"get(_:fields:include:)","type":"topic","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fields"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Fetches a user using its identifier."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","type":"topic","url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"text":"Management API v2","type":"text"}]},"https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id":{"title":"Management API Endpoint","type":"link","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-8mfww":{"role":"symbol","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","kind":"symbol","title":"get(_:fields:include:)","abstract":[{"type":"text","text":"Fetches a user using its identifier."}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users/get(_:fields:include:)-8mfww.json b/docs/data/documentation/auth0/users/get(_:fields:include:)-8mfww.json index 252ca105..3521646b 100644 --- a/docs/data/documentation/auth0/users/get(_:fields:include:)-8mfww.json +++ b/docs/data/documentation/auth0/users/get(_:fields:include:)-8mfww.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"]}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln"],"title":"Users Implementations"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"parameters":[{"name":"identifier","content":[{"type":"paragraph","inlineContent":[{"text":"ID of the user. You can get this value from the ","type":"text"},{"type":"codeVoice","code":"sub"},{"text":" claim of the user’s ID token, or from the ","type":"text"},{"type":"codeVoice","code":"sub"},{"type":"text","text":" property of a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true},{"type":"text","text":" instance."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"List of the user’s field names that will be included\/excluded in the response. By default all will be retrieved.","type":"text"}]}],"name":"fields"},{"content":[{"inlineContent":[{"text":"Flag that indicates that only the names in ‘fields’ should be included\/excluded in the response. By default it will include them.","type":"text"}],"type":"paragraph"}],"name":"include"}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"A request that will yield a user."}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"inlineContent":[{"type":"text","text":"By default it gets all the user’s attributes:"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\")"," .start { result in"," switch result {"," case .success(let user):"," print(\"Obtained user: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"inlineContent":[{"type":"text","text":"You can select which attributes you want:"}],"type":"paragraph"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"email\", \"user_id\"])"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can even exclude some attributes:"}]},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"identities\", \"app_metadata\"], include: false)"," .start { print($0) }"],"syntax":"swift","type":"codeListing"},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The token must have the scope "},{"code":"read:users","type":"codeVoice"},{"type":"text","text":" scope."}]}],"style":"note","type":"aside"}]}],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"include"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","externalID":"s:5Auth05UsersP3get_6fields7includeAA7RequestVySDySSypGAA15ManagementErrorVGSS_SaySSGSbtF","symbolKind":"method","role":"symbol","required":true,"title":"get(_:fields:include:)","modules":[{"name":"Auth0"}]},"variants":[{"paths":["\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id":{"titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id","type":"link","title":"Management API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject","title":"ManagementObject","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-7aaln":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"include"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"type":"topic","title":"get(_:fields:include:)","abstract":[{"text":"Fetches a user using its identifier.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"text":"Management API v2","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-8mfww":{"type":"topic","role":"symbol","kind":"symbol","title":"get(_:fields:include:)","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","abstract":[{"text":"Fetches a user using its identifier.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","defaultImplementations":1,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"text":"include","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"get","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fields"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"text":"include","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the user. You can get this value from the "},{"code":"sub","type":"codeVoice"},{"text":" claim of the user’s ID token, or from the ","type":"text"},{"type":"codeVoice","code":"sub"},{"type":"text","text":" property of a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"type":"text","text":" instance."}]}],"name":"identifier"},{"content":[{"inlineContent":[{"type":"text","text":"List of the user’s field names that will be included\/excluded in the response. By default all will be retrieved."}],"type":"paragraph"}],"name":"fields"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Flag that indicates that only the names in ‘fields’ should be included\/excluded in the response. By default it will include them."}]}],"name":"include"}]},{"content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"inlineContent":[{"text":"A request that will yield a user.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"inlineContent":[{"text":"By default it gets all the user’s attributes:","type":"text"}],"type":"paragraph"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\")"," .start { result in"," switch result {"," case .success(let user):"," print(\"Obtained user: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can select which attributes you want:"}]},{"syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"email\", \"user_id\"])"," .start { print($0) }"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"text":"You can even exclude some attributes:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"identities\", \"app_metadata\"], include: false)"," .start { print($0) }"]},{"style":"note","name":"Requires","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The token must have the scope "},{"code":"read:users","type":"codeVoice"},{"type":"text","text":" scope."}]}]}],"kind":"content"}],"defaultImplementationsSections":[{"title":"Users Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln"]}],"kind":"symbol","abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"role":"symbol","roleHeading":"Instance Method","required":true,"title":"get(_:fields:include:)","externalID":"s:5Auth05UsersP3get_6fields7includeAA7RequestVySDySSypGAA15ManagementErrorVGSS_SaySSGSbtF","modules":[{"name":"Auth0"}],"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-8mfww":{"role":"symbol","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-8mfww","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","kind":"symbol","title":"get(_:fields:include:)","abstract":[{"type":"text","text":"Fetches a user using its identifier."}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-7aaln":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","kind":"symbol","role":"symbol","title":"get(_:fields:include:)","type":"topic","url":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fields"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Fetches a user using its identifier."}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","type":"topic","url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"type":"text","text":"Management API v2"}],"title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id":{"type":"link","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id","title":"Management API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users/link(_:withotherusertoken:).json b/docs/data/documentation/auth0/users/link(_:withotherusertoken:).json index 7ae1de26..df0044ea 100644 --- a/docs/data/documentation/auth0/users/link(_:withotherusertoken:).json +++ b/docs/data/documentation/auth0/users/link(_:withotherusertoken:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"withOtherUserToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","symbolKind":"method","title":"link(_:withOtherUserToken:)","required":true,"externalID":"s:5Auth05UsersP4link_18withOtherUserTokenAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_SStF"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"],"title":"Related Documentation"}],"kind":"symbol","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its ID token."},{"text":" ","type":"text"},{"type":"text","text":"After this request the primary user will hold another identity in its "},{"code":"identities","type":"codeVoice"},{"type":"text","text":" attribute, which will represent"},{"text":" ","type":"text"},{"type":"text","text":"the secondary user."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withOtherUserToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"token","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<["},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"text":"ManagementError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"ID of the primary user who will be linked against a secondary one. You can get this value from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"type":"text","text":" claim of the primary user’s ID token, or from the "},{"type":"codeVoice","code":"sub"},{"text":" property of a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"text":" instance.","type":"text"}],"type":"paragraph"}],"name":"identifier"},{"name":"token","content":[{"type":"paragraph","inlineContent":[{"text":"ID token of the secondary user.","type":"text"}]}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request to link two users."}]}]},{"content":[{"level":2,"type":"heading","text":"Usage","anchor":"Usage"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .link(\"primary-user-id\", withOtherUserToken: \"secondary-id-token\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The token must have the scope "},{"code":"update:current_user_identities","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","type":"aside"}],"kind":"content"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/users\/link(_:withotherusertoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","titleInlineContent":[{"text":"Management API v2","type":"text"}],"type":"link"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"title":"User Account Linking","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","type":"link","titleInlineContent":[{"type":"text","text":"User Account Linking"}],"url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/api/management/v2#!/Users/post_identities":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","title":"Management API Endpoint","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withOtherUserToken:)":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"withOtherUserToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}],"abstract":[{"text":"Links a user given its identifier with a secondary user given its ID token.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"After this request the primary user will hold another identity in its "},{"code":"identities","type":"codeVoice"},{"type":"text","text":" attribute, which will represent"},{"text":" ","type":"text"},{"text":"the secondary user.","type":"text"}],"kind":"symbol","title":"link(_:withOtherUserToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","url":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject","title":"ManagementObject","role":"symbol","type":"topic"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/users\/link(_:withotherusertoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its ID token."},{"type":"text","text":" "},{"text":"After this request the primary user will hold another identity in its ","type":"text"},{"type":"codeVoice","code":"identities"},{"type":"text","text":" attribute, which will represent"},{"text":" ","type":"text"},{"type":"text","text":"the secondary user."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"]}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"withOtherUserToken","kind":"externalParam"},{"kind":"text","text":" "},{"text":"token","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the primary user who will be linked against a secondary one. You can get this value from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the primary user’s ID token, or from the "},{"code":"sub","type":"codeVoice"},{"type":"text","text":" property of a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true},{"type":"text","text":" instance."}]}],"name":"identifier"},{"name":"token","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID token of the secondary user."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request to link two users.","type":"text"}]}]},{"content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .link(\"primary-user-id\", withOtherUserToken: \"secondary-id-token\")"," .start { print($0) }"]},{"content":[{"type":"paragraph","inlineContent":[{"text":"The token must have the scope ","type":"text"},{"type":"codeVoice","code":"update:current_user_identities"},{"text":".","type":"text"}]}],"name":"Requires","type":"aside","style":"note"}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","interfaceLanguage":"swift"},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"link"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"withOtherUserToken","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":"], ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"title":"link(_:withOtherUserToken:)","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"required":true,"externalID":"s:5Auth05UsersP4link_18withOtherUserTokenAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_SStF"},"kind":"symbol","references":{"https://auth0.com/docs/api/management/v2#!/Users/post_identities":{"titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","title":"Management API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withOtherUserToken:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"withOtherUserToken"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<["},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","title":"link(_:withOtherUserToken:)","kind":"symbol","required":true,"abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its ID token."},{"type":"text","text":" "},{"text":"After this request the primary user will hold another identity in its ","type":"text"},{"type":"codeVoice","code":"identities"},{"text":" attribute, which will represent","type":"text"},{"type":"text","text":" "},{"text":"the secondary user.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","type":"topic","url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"titleInlineContent":[{"type":"text","text":"User Account Linking"}],"url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","title":"User Account Linking","type":"link","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","titleInlineContent":[{"text":"Management API v2","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users/link(_:withuser:provider:connectionid:)-5y4yy.json b/docs/data/documentation/auth0/users/link(_:withuser:provider:connectionid:)-5y4yy.json index 8f6db463..ace97312 100644 --- a/docs/data/documentation/auth0/users/link(_:withuser:provider:connectionid:)-5y4yy.json +++ b/docs/data/documentation/auth0/users/link(_:withuser:provider:connectionid:)-5y4yy.json @@ -1 +1 @@ -{"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"]}],"metadata":{"externalID":"s:5Auth05UsersP4link_8withUser8provider12connectionIdAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S3SSgtF","role":"symbol","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"withUser"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"connectionId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":"], ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","required":true,"title":"link(_:withUser:provider:connectionId:)"},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"withUser","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"userId","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"provider","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"connectionId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<[","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier","text":"ManagementError"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"identifier","content":[{"type":"paragraph","inlineContent":[{"text":"ID of the primary user who will be linked against a secondary one. You can get this value from the ","type":"text"},{"type":"codeVoice","code":"sub"},{"text":" claim of the primary user’s ID token, or from the ","type":"text"},{"type":"codeVoice","code":"sub"},{"type":"text","text":" property of a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"text":" instance.","type":"text"}]}]},{"name":"userId","content":[{"inlineContent":[{"type":"text","text":"ID of the secondary user. You can get this value from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the secondary user’s ID token, or from the "},{"code":"sub","type":"codeVoice"},{"type":"text","text":" property of a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"text":" instance.","type":"text"}],"type":"paragraph"}]},{"name":"provider","content":[{"inlineContent":[{"text":"Name of the provider for the secondary user, for example ‘auth0’ for database connections.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"ID of the connection for the secondary user."}],"type":"paragraph"}],"name":"connectionId"}],"kind":"parameters"},{"content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A request to link two users."}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .link(\"primary-user-id\", userId: \"secondary-user-id\", provider: \"auth0\", connectionId: \"connection-id\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The token must have the scope "},{"code":"update:users","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","type":"aside"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","interfaceLanguage":"swift"},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7"],"title":"Users Implementations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject","title":"ManagementObject","role":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"text":"Management API v2","type":"text"}],"title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","titleInlineContent":[{"text":"User Account Linking","type":"text"}],"url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","title":"User Account Linking"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2#!/Users/post_identities":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"title":"Management API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-5y4yy":{"type":"topic","role":"symbol","kind":"symbol","title":"link(_:withUser:provider:connectionId:)","url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","defaultImplementations":1,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-6nwr7":{"title":"link(_:withUser:provider:connectionId:)","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withUser"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"text":"], ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic"}}} \ No newline at end of file +{"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","interfaceLanguage":"swift"},"defaultImplementationsSections":[{"title":"Users Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"]}],"kind":"symbol","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"metadata":{"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"role":"symbol","externalID":"s:5Auth05UsersP4link_8withUser8provider12connectionIdAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S3SSgtF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"required":true,"title":"link(_:withUser:provider:connectionId:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"withUser","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"userId","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connectionId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},{"kind":"text","text":"], "},{"text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"identifier","content":[{"inlineContent":[{"text":"ID of the primary user who will be linked against a secondary one. You can get this value from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"type":"text","text":" claim of the primary user’s ID token, or from the "},{"type":"codeVoice","code":"sub"},{"text":" property of a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"text":" instance.","type":"text"}],"type":"paragraph"}]},{"name":"userId","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the secondary user. You can get this value from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the secondary user’s ID token, or from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" property of a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"text":" instance.","type":"text"}]}]},{"name":"provider","content":[{"inlineContent":[{"type":"text","text":"Name of the provider for the secondary user, for example ‘auth0’ for database connections."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"ID of the connection for the secondary user.","type":"text"}],"type":"paragraph"}],"name":"connectionId"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request to link two users."}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .link(\"primary-user-id\", userId: \"secondary-user-id\", provider: \"auth0\", connectionId: \"connection-id\")"," .start { print($0) }"]},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The token must have the scope "},{"type":"codeVoice","code":"update:users"},{"text":".","type":"text"}]}],"name":"Requires","style":"note"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","type":"topic","url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-5y4yy":{"title":"link(_:withUser:provider:connectionId:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","kind":"symbol","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"type":"topic","required":true,"role":"symbol","defaultImplementations":1,"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"withUser","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<["},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}]},"https://auth0.com/docs/api/management/v2":{"type":"link","titleInlineContent":[{"type":"text","text":"Management API v2"}],"title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"type":"link","titleInlineContent":[{"type":"text","text":"User Account Linking"}],"title":"User Account Linking","url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"},"https://auth0.com/docs/api/management/v2#!/Users/post_identities":{"title":"Management API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","type":"link","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-6nwr7":{"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"link"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withUser"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"connectionId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"link(_:withUser:provider:connectionId:)","type":"topic","url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users/link(_:withuser:provider:connectionid:)-6nwr7.json b/docs/data/documentation/auth0/users/link(_:withuser:provider:connectionid:)-6nwr7.json index 98e1bded..267aeb03 100644 --- a/docs/data/documentation/auth0/users/link(_:withuser:provider:connectionid:)-6nwr7.json +++ b/docs/data/documentation/auth0/users/link(_:withuser:provider:connectionid:)-6nwr7.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"userId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"provider"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"connectionId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"identifier","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the primary user who will be linked against a secondary one. You can get this value from the "},{"code":"sub","type":"codeVoice"},{"type":"text","text":" claim of the primary user’s ID token, or from the "},{"type":"codeVoice","code":"sub"},{"text":" property of a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"text":" instance.","type":"text"}]}]},{"name":"userId","content":[{"inlineContent":[{"text":"ID of the secondary user. You can get this value from the ","type":"text"},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the secondary user’s ID token, or from the "},{"type":"codeVoice","code":"sub"},{"text":" property of a ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"type":"text","text":" instance."}],"type":"paragraph"}]},{"name":"provider","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the provider for the secondary user, for example ‘auth0’ for database connections."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the connection for the secondary user."}]}],"name":"connectionId"}]},{"content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"inlineContent":[{"text":"A request to link two users.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .link(\"primary-user-id\", userId: \"secondary-user-id\", provider: \"auth0\", connectionId: \"connection-id\")"," .start { print($0) }"]},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"The token must have the scope ","type":"text"},{"code":"update:users","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"Requires","type":"aside"}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7"},"metadata":{"role":"symbol","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"connectionId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"text":">","kind":"text"}],"extendedModule":"Auth0","title":"link(_:withUser:provider:connectionId:)","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth05UsersPAAE4link_8withUser8provider12connectionIdAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S3SSgtF"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7"]}],"abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-5y4yy":{"type":"topic","role":"symbol","kind":"symbol","title":"link(_:withUser:provider:connectionId:)","url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","defaultImplementations":1,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-6nwr7":{"title":"link(_:withUser:provider:connectionId:)","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withUser"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"text":"], ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject","title":"ManagementObject","role":"symbol","type":"topic"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","titleInlineContent":[{"text":"User Account Linking","type":"text"}],"title":"User Account Linking","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","type":"link"},"https://auth0.com/docs/api/management/v2#!/Users/post_identities":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","type":"link","title":"Management API Endpoint","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}]},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"text":"Management API v2","type":"text"}],"title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"withUser","kind":"externalParam"},{"kind":"text","text":" "},{"text":"userId","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil) -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"kind":"text","text":">"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"identifier","content":[{"inlineContent":[{"text":"ID of the primary user who will be linked against a secondary one. You can get this value from the ","type":"text"},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the primary user’s ID token, or from the "},{"code":"sub","type":"codeVoice"},{"text":" property of a ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"text":" instance.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"ID of the secondary user. You can get this value from the ","type":"text"},{"type":"codeVoice","code":"sub"},{"text":" claim of the secondary user’s ID token, or from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"type":"text","text":" property of a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"text":" instance.","type":"text"}]}],"name":"userId"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the provider for the secondary user, for example ‘auth0’ for database connections.","type":"text"}]}],"name":"provider"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the connection for the secondary user."}]}],"name":"connectionId"}]},{"content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request to link two users."}]}],"kind":"content"},{"content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .link(\"primary-user-id\", userId: \"secondary-user-id\", provider: \"auth0\", connectionId: \"connection-id\")"," .start { print($0) }"],"type":"codeListing"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The token must have the scope "},{"type":"codeVoice","code":"update:users"},{"type":"text","text":"."}]}],"style":"note","name":"Requires"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Instance Method","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withUser"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connectionId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"text":"], ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"symbolKind":"method","title":"link(_:withUser:provider:connectionId:)","role":"symbol","externalID":"s:5Auth05UsersPAAE4link_8withUser8provider12connectionIdAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S3SSgtF"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy"]]},"abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-5y4yy":{"title":"link(_:withUser:provider:connectionId:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-5y4yy","kind":"symbol","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"type":"topic","required":true,"role":"symbol","defaultImplementations":1,"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"withUser","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"kind":"text","text":"<["},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","type":"topic","url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"https://auth0.com/docs/api/management/v2#!/Users/post_identities":{"titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","type":"link","title":"Management API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-6nwr7":{"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"link"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withUser"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"connectionId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"link(_:withUser:provider:connectionId:)","type":"topic","url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7"},"https://auth0.com/docs/api/management/v2":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","type":"link","titleInlineContent":[{"text":"Management API v2","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"titleInlineContent":[{"text":"User Account Linking","type":"text"}],"url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","type":"link","title":"User Account Linking"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users/patch(_:attributes:).json b/docs/data/documentation/auth0/users/patch(_:attributes:).json index e8fccb81..c161612a 100644 --- a/docs/data/documentation/auth0/users/patch(_:attributes:).json +++ b/docs/data/documentation/auth0/users/patch(_:attributes:).json @@ -1 +1 @@ -{"metadata":{"symbolKind":"method","platforms":[],"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"attributes"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"required":true,"modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth05UsersP5patch_10attributesAA7RequestVySDySSypGAA15ManagementErrorVGSS_AA19UserPatchAttributesCtF","title":"patch(_:attributes:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"identifier","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the user to update. You can get this value from the "},{"code":"sub","type":"codeVoice"},{"type":"text","text":" claim of the user’s ID token, or from the "},{"code":"sub","type":"codeVoice"},{"text":" property of a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"type":"text","text":" instance."}]}]},{"name":"attributes","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Root attributes to be updated."}]}]}]},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield the updated user."}]}],"kind":"content"},{"kind":"content","content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"For example, if you need to change the "},{"code":"email","type":"codeVoice"},{"type":"text","text":":"}]},{"code":["let attributes = UserPatchAttributes().email(\"new.email@auth0.com\","," connection: \"Username-Password-Authentication\","," clientId: clientId)"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"type":"text","text":"Or, if you need to change the "},{"type":"codeVoice","code":"user_metadata"},{"text":":","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["let attributes = UserPatchAttributes().userMetadata([\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"text":"You can even chain several changes together:","type":"text"}]},{"syntax":"swift","code":["let attributes = UserPatchAttributes()"," .email(\"new.email@auth0.com\","," verify: true, "," connection: \"Username-Password-Authentication\", "," clientId: clientId)"," .userMetadata([\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .appMetadata([\"role\": \"admin\"])"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"text":"Then, just pass the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","isActive":true,"type":"reference"},{"type":"text","text":" to the patch method:"}]},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .patch(\"user-id\", attributes: attributes)"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"style":"note","name":"Requires","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The token must have one of the following scopes: "},{"type":"codeVoice","code":"update:users"},{"type":"text","text":", "},{"type":"codeVoice","code":"update:users_app_metadata"},{"type":"text","text":"."}]}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/patch(_:attributes:)"]}],"deprecationSummary":[{"inlineContent":[{"type":"text","text":"This operation can no longer be performed from native apps for security reasons"}],"type":"paragraph"}],"kind":"symbol","abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id":{"titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"type":"link","title":"Management API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"kind":"symbol","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"title":"patch(_:attributes:)","deprecated":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","type":"reference"},{"type":"text","text":" method of "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject","title":"ManagementObject","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"text":"Management API v2","type":"text"}],"type":"link","title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This operation can no longer be performed from native apps for security reasons"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"metadata":{"symbolKind":"method","required":true,"modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}],"platforms":[],"title":"patch(_:attributes:)","externalID":"s:5Auth05UsersP5patch_10attributesAA7RequestVySDySSypGAA15ManagementErrorVGSS_AA19UserPatchAttributesCtF","roleHeading":"Instance Method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"],"title":"Related Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/users\/patch(_:attributes:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier","text":"ManagementError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"identifier","content":[{"inlineContent":[{"type":"text","text":"ID of the user to update. You can get this value from the "},{"type":"codeVoice","code":"sub"},{"text":" claim of the user’s ID token, or from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"text":" property of a ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"type":"text","text":" instance."}],"type":"paragraph"}]},{"name":"attributes","content":[{"inlineContent":[{"type":"text","text":"Root attributes to be updated."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield the updated user."}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"paragraph","inlineContent":[{"type":"text","text":"For example, if you need to change the "},{"type":"codeVoice","code":"email"},{"type":"text","text":":"}]},{"code":["let attributes = UserPatchAttributes().email(\"new.email@auth0.com\","," connection: \"Username-Password-Authentication\","," clientId: clientId)"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Or, if you need to change the "},{"code":"user_metadata","type":"codeVoice"},{"type":"text","text":":"}]},{"syntax":"swift","code":["let attributes = UserPatchAttributes().userMetadata([\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"text":"You can even chain several changes together:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["let attributes = UserPatchAttributes()"," .email(\"new.email@auth0.com\","," verify: true, "," connection: \"Username-Password-Authentication\", "," clientId: clientId)"," .userMetadata([\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .appMetadata([\"role\": \"admin\"])"]},{"inlineContent":[{"type":"text","text":"Then, just pass the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","isActive":true,"type":"reference"},{"type":"text","text":" to the patch method:"}],"type":"paragraph"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .patch(\"user-id\", attributes: attributes)"," .start { print($0) }"],"syntax":"swift","type":"codeListing"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The token must have one of the following scopes: "},{"code":"update:users","type":"codeVoice"},{"text":", ","type":"text"},{"code":"update:users_app_metadata","type":"codeVoice"},{"type":"text","text":"."}]}],"type":"aside","name":"Requires"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"title":"patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","role":"symbol","deprecated":true},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","titleInlineContent":[{"type":"text","text":"Management API v2"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","type":"topic","url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},"https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id":{"title":"Management API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)"},{"text":" method of ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users/patch(_:usermetadata:).json b/docs/data/documentation/auth0/users/patch(_:usermetadata:).json index 2a1bee57..45461fe4 100644 --- a/docs/data/documentation/auth0/users/patch(_:usermetadata:).json +++ b/docs/data/documentation/auth0/users/patch(_:usermetadata:).json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"Updates only the user’s ","type":"text"},{"code":"user_metadata","type":"codeVoice"},{"type":"text","text":" field."}],"sections":[],"metadata":{"externalID":"s:5Auth05UsersP5patch_12userMetadataAA7RequestVySDySSypGAA15ManagementErrorVGSS_AHtF","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"userMetadata"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}],"symbolKind":"method","title":"patch(_:userMetadata:)","roleHeading":"Instance Method","required":true,"modules":[{"name":"Auth0"}],"role":"symbol"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)"},"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"ID of the user to update. You can get this value from the ","type":"text"},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the user’s ID token, or from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" property of a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true},{"text":" instance.","type":"text"}]}],"name":"identifier"},{"content":[{"inlineContent":[{"text":"Metadata to update.","type":"text"}],"type":"paragraph"}],"name":"userMetadata"}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield the updated user."}]}]},{"kind":"content","content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .patch(\"user-id\", userMetadata: [\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .start { print($0) }"],"type":"codeListing"},{"name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The token must have the "},{"type":"codeVoice","code":"update:current_user_metadata"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/patch(_:usermetadata:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject","title":"ManagementObject","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id","type":"link","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id","title":"Management API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","titleInlineContent":[{"type":"text","text":"Management API v2"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:userMetadata:)":{"type":"topic","role":"symbol","kind":"symbol","title":"patch(_:userMetadata:)","url":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","abstract":[{"type":"text","text":"Updates only the user’s "},{"code":"user_metadata","type":"codeVoice"},{"text":" field.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}],"required":true}}} \ No newline at end of file +{"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"kind":"symbol","sections":[],"variants":[{"paths":["\/documentation\/auth0\/users\/patch(_:usermetadata:)"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"identifier","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the user to update. You can get this value from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the user’s ID token, or from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" property of a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true},{"type":"text","text":" instance."}]}],"name":"identifier"},{"name":"userMetadata","content":[{"inlineContent":[{"type":"text","text":"Metadata to update."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield the updated user.","type":"text"}]}]},{"kind":"content","content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .patch(\"user-id\", userMetadata: [\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .start { print($0) }"]},{"type":"aside","style":"note","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The token must have the "},{"type":"codeVoice","code":"update:current_user_metadata"},{"text":" scope.","type":"text"}]}]}]}],"abstract":[{"type":"text","text":"Updates only the user’s "},{"code":"user_metadata","type":"codeVoice"},{"type":"text","text":" field."}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"required":true,"title":"patch(_:userMetadata:)","roleHeading":"Instance Method","externalID":"s:5Auth05UsersP5patch_12userMetadataAA7RequestVySDySSypGAA15ManagementErrorVGSS_AHtF","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"userMetadata"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"references":{"https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id":{"title":"Management API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:userMetadata:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"type":"topic","url":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","title":"patch(_:userMetadata:)","abstract":[{"type":"text","text":"Updates only the user’s "},{"type":"codeVoice","code":"user_metadata"},{"type":"text","text":" field."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"text":"Management API v2","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","type":"topic","url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users/token.json b/docs/data/documentation/auth0/users/token.json index dbf109bd..8521295c 100644 --- a/docs/data/documentation/auth0/users/token.json +++ b/docs/data/documentation/auth0/users/token.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/users\/token"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth05UsersP5tokenSSvp","symbolKind":"property","title":"token","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"token","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"modules":[{"name":"Auth0"}],"role":"symbol","required":true,"roleHeading":"Instance Property"},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"The Management API token.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"token"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"references":{"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","titleInlineContent":[{"type":"text","text":"Management API v2"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/token":{"type":"topic","role":"symbol","kind":"symbol","title":"token","url":"\/documentation\/auth0\/users\/token","abstract":[{"type":"text","text":"The Management API token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"token","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Property","title":"token","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"token"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","externalID":"s:5Auth05UsersP5tokenSSvp","symbolKind":"property","required":true,"modules":[{"name":"Auth0"}]},"abstract":[{"text":"The Management API token.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/token"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"token","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/token":{"role":"symbol","title":"token","abstract":[{"type":"text","text":"The Management API token."}],"kind":"symbol","type":"topic","required":true,"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"token"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/users\/token","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","type":"link","titleInlineContent":[{"text":"Management API v2","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users/unlink(identityid:provider:fromuserid:).json b/docs/data/documentation/auth0/users/unlink(identityid:provider:fromuserid:).json index 2a86a0c4..38c63123 100644 --- a/docs/data/documentation/auth0/users/unlink(identityid:provider:fromuserid:).json +++ b/docs/data/documentation/auth0/users/unlink(identityid:provider:fromuserid:).json @@ -1 +1 @@ -{"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/delete_user_identity_by_user_id","https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"],"title":"Related Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unlink","kind":"identifier"},{"kind":"text","text":"("},{"text":"identityId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fromUserId"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<["},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject"},{"text":"], ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"identityId","content":[{"type":"paragraph","inlineContent":[{"text":"ID of the identity to remove.","type":"text"}]}]},{"name":"provider","content":[{"inlineContent":[{"type":"text","text":"Name of the identity provider."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the user who owns the identity. You can get this value from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the user’s ID token, or from the "},{"code":"sub","type":"codeVoice"},{"text":" property of a ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"type":"text","text":" instance."}]}],"name":"identifier"}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"text":"A request to remove an identity.","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .unlink(identityId: \"identity-id\", provider: \"github\", fromUserId: \"user-id\")"," .start { print($0) }"],"syntax":"swift","type":"codeListing"},{"content":[{"inlineContent":[{"text":"The token must have the scope ","type":"text"},{"code":"update:users","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Requires","style":"note","type":"aside"}],"kind":"content"}],"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)"]}],"abstract":[{"text":"Removes an identity from a user.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)"},"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"roleHeading":"Instance Method","role":"symbol","symbolKind":"method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth05UsersP6unlink10identityId8provider08fromUserE0AA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S2StF","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"unlink","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"identityId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fromUserId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"text":">","kind":"text"}],"required":true,"title":"unlink(identityId:provider:fromUserId:)"},"references":{"https://auth0.com/docs/api/management/v2#!/Users/delete_user_identity_by_user_id":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/delete_user_identity_by_user_id","type":"link","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"title":"Management API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/delete_user_identity_by_user_id"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"url":"\/documentation\/auth0\/request","type":"topic","title":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"symbol","abstract":[{"text":"Auth0 API request.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","title":"UserInfo","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementError"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","title":"ManagementError","role":"symbol","type":"topic"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","title":"User Account Linking","titleInlineContent":[{"type":"text","text":"User Account Linking"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject","title":"ManagementObject","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/unlink(identityId:provider:fromUserId:)":{"type":"topic","role":"symbol","kind":"symbol","title":"unlink(identityId:provider:fromUserId:)","url":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","abstract":[{"text":"Removes an identity from a user.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"unlink"},{"kind":"text","text":"("},{"text":"identityId","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fromUserId"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":"], "},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"required":true},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","titleInlineContent":[{"type":"text","text":"Management API v2"}],"title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"unlink","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"identityId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fromUserId"},{"kind":"text","text":" "},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":"], ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"identityId","content":[{"inlineContent":[{"text":"ID of the identity to remove.","type":"text"}],"type":"paragraph"}]},{"name":"provider","content":[{"inlineContent":[{"type":"text","text":"Name of the identity provider."}],"type":"paragraph"}]},{"name":"identifier","content":[{"inlineContent":[{"type":"text","text":"ID of the user who owns the identity. You can get this value from the "},{"code":"sub","type":"codeVoice"},{"type":"text","text":" claim of the user’s ID token, or from the "},{"code":"sub","type":"codeVoice"},{"text":" property of a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"type":"text","text":" instance."}],"type":"paragraph"}]}]},{"content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request to remove an identity."}]}],"kind":"content"},{"kind":"content","content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"type":"codeListing","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .unlink(identityId: \"identity-id\", provider: \"github\", fromUserId: \"user-id\")"," .start { print($0) }"],"syntax":"swift"},{"style":"note","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"text":"The token must have the scope ","type":"text"},{"type":"codeVoice","code":"update:users"},{"text":".","type":"text"}]}],"type":"aside"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Removes an identity from a user.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"externalID":"s:5Auth05UsersP6unlink10identityId8provider08fromUserE0AA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S2StF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unlink","kind":"identifier"},{"kind":"text","text":"("},{"text":"identityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"fromUserId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"required":true,"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","symbolKind":"method","title":"unlink(identityId:provider:fromUserId:)"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/delete_user_identity_by_user_id","https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"],"title":"Related Documentation"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"references":{"https://auth0.com/docs/api/management/v2":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","titleInlineContent":[{"type":"text","text":"Management API v2"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Users/unlink(identityId:provider:fromUserId:)":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"unlink","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"identityId"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"fromUserId"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","abstract":[{"type":"text","text":"Removes an identity from a user."}],"type":"topic","kind":"symbol","title":"unlink(identityId:provider:fromUserId:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"url":"\/documentation\/auth0\/request","abstract":[{"type":"text","text":"Auth0 API request."}],"navigatorTitle":[{"text":"Request","kind":"identifier"}]},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"titleInlineContent":[{"text":"User Account Linking","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","title":"User Account Linking"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementObject"}],"navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","type":"topic","url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"title":"UserInfo","type":"topic","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"url":"\/documentation\/auth0\/userinfo","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"https://auth0.com/docs/api/management/v2#!/Users/delete_user_identity_by_user_id":{"titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"title":"Management API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/delete_user_identity_by_user_id","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/delete_user_identity_by_user_id","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users/url.json b/docs/data/documentation/auth0/users/url.json index ea3cacb2..02385190 100644 --- a/docs/data/documentation/auth0/users/url.json +++ b/docs/data/documentation/auth0/users/url.json @@ -1 +1 @@ -{"sections":[],"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"externalID":"s:5Auth05UsersP3url10Foundation3URLVvp","title":"url","role":"symbol","required":true,"symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/url"]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/url":{"type":"topic","role":"symbol","kind":"symbol","title":"url","url":"\/documentation\/auth0\/users\/url","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"text":"Management API v2","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","title":"Users","role":"symbol","type":"topic"}}} \ No newline at end of file +{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/users\/url"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"metadata":{"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"url","externalID":"s:5Auth05UsersP3url10Foundation3URLVvp","required":true},"references":{"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"type":"text","text":"Management API v2"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","title":"Management API v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"title":"Users","type":"topic","abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/users","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"doc://com.auth0.Auth0/documentation/Auth0/Users/url":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url","required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"type":"topic","url":"\/documentation\/auth0\/users\/url","title":"url","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth(clientid:domain:session:).json b/docs/data/documentation/auth0/webauth(clientid:domain:session:).json index 3e893522..a7205fdd 100644 --- a/docs/data/documentation/auth0/webauth(clientid:domain:session:).json +++ b/docs/data/documentation/auth0/webauth(clientid:domain:session:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Auth0 client for performing web-based authentication with "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"reference"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":" = .shared) -> ","kind":"text"},{"text":"WebAuth","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Client ID of your Auth0 application.","type":"text"}],"type":"paragraph"}],"name":"clientId"},{"name":"domain","content":[{"inlineContent":[{"type":"text","text":"Domain of your Auth0 account, for example "},{"type":"codeVoice","code":"samples.us.auth0.com"},{"text":".","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":"URLSession"},{"type":"text","text":" instance used for networking. Defaults to "},{"type":"codeVoice","code":"URLSession.shared"},{"type":"text","text":"."}]}],"name":"session"}]},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"Auth0 Web Auth client.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"code":["Auth0.webAuth(clientId: \"client-id\", domain: \"samples.us.auth0.com\")"],"type":"codeListing","syntax":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth(clientid:domain:session:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","metadata":{"roleHeading":"Function","role":"symbol","symbolKind":"func","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"text":") -> ","kind":"text"},{"text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"title":"webAuth(clientId:domain:session:)","externalID":"s:5Auth07webAuth8clientId6domain7sessionAA03WebC0_pSS_SSSo12NSURLSessionCtF"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"titleInlineContent":[{"text":"Universal Login","type":"text"}],"title":"Universal Login","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(clientId:domain:session:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"webAuth","kind":"identifier"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"WebAuth","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP"}],"abstract":[{"type":"text","text":"Auth0 client for performing web-based authentication with "},{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"reference","isActive":true},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/webauth(clientid:domain:session:)","title":"webAuth(clientId:domain:session:)","role":"symbol","type":"topic"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"clientId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":" = .shared) -> "},{"preciseIdentifier":"s:5Auth07WebAuthP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","text":"WebAuth","kind":"typeIdentifier"}]}]},{"kind":"parameters","parameters":[{"name":"clientId","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Client ID of your Auth0 application."}]}]},{"name":"domain","content":[{"inlineContent":[{"type":"text","text":"Domain of your Auth0 account, for example "},{"type":"codeVoice","code":"samples.us.auth0.com"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"session","content":[{"inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"URLSession"},{"text":" instance used for networking. Defaults to ","type":"text"},{"type":"codeVoice","code":"URLSession.shared"},{"text":".","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"inlineContent":[{"type":"text","text":"Auth0 Web Auth client."}],"type":"paragraph"}]},{"content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"syntax":"swift","code":["Auth0.webAuth(clientId: \"client-id\", domain: \"samples.us.auth0.com\")"],"type":"codeListing"}],"kind":"content"}],"abstract":[{"type":"text","text":"Auth0 client for performing web-based authentication with "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"reference"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth(clientid:domain:session:)"]}],"metadata":{"title":"webAuth(clientId:domain:session:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"domain","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"WebAuth","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP"}],"externalID":"s:5Auth07webAuth8clientId6domain7sessionAA03WebC0_pSS_SSSo12NSURLSessionCtF","roleHeading":"Function","symbolKind":"func","role":"symbol"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/webAuth(clientId:domain:session:)":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":") -> ","kind":"text"},{"text":"WebAuth","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP"}],"url":"\/documentation\/auth0\/webauth(clientid:domain:session:)","title":"webAuth(clientId:domain:session:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","abstract":[{"text":"Auth0 client for performing web-based authentication with ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},{"text":".","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","title":"Universal Login","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"link","titleInlineContent":[{"type":"text","text":"Universal Login"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth(session:bundle:).json b/docs/data/documentation/auth0/webauth(session:bundle:).json index 225cc20b..32c6b443 100644 --- a/docs/data/documentation/auth0/webauth(session:bundle:).json +++ b/docs/data/documentation/auth0/webauth(session:bundle:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/webauth(session:bundle:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"text":"(","kind":"text"},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":" = .shared, ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"text":" = Bundle.main) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier","text":"WebAuth","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"}]}]},{"kind":"parameters","parameters":[{"name":"session","content":[{"inlineContent":[{"text":"","type":"text"},{"code":"URLSession","type":"codeVoice"},{"text":" instance used for networking. Defaults to ","type":"text"},{"type":"codeVoice","code":"URLSession.shared"},{"type":"text","text":"."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Bundle used to locate the "},{"type":"codeVoice","code":"Auth0.plist"},{"type":"text","text":" file. Defaults to "},{"type":"codeVoice","code":"Bundle.main"},{"type":"text","text":"."}]}],"name":"bundle"}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0 Web Auth client."}]}]},{"kind":"content","content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0.webAuth()"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The Auth0 Domain is loaded from the "},{"code":"Auth0.plist","type":"codeVoice"},{"type":"text","text":" file in your main bundle. It should have the following content:"}]},{"code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"],"type":"codeListing","syntax":"xml"},{"style":"warning","type":"aside","content":[{"inlineContent":[{"text":"Calling this method without a valid ","type":"text"},{"type":"codeVoice","code":"Auth0.plist"},{"text":" file will crash your application.","type":"text"}],"type":"paragraph"}],"name":"Warning"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"Auth0 client for performing web-based authentication with ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},{"text":".","type":"text"}],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":", "},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP"}],"symbolKind":"func","role":"symbol","roleHeading":"Function","title":"webAuth(session:bundle:)","externalID":"s:5Auth07webAuth7session6bundleAA03WebC0_pSo12NSURLSessionC_So8NSBundleCtF"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","title":"Universal Login","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","titleInlineContent":[{"type":"text","text":"Universal Login"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(session:bundle:)":{"abstract":[{"text":"Auth0 client for performing web-based authentication with ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true},{"text":".","type":"text"}],"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":", "},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth"}],"url":"\/documentation\/auth0\/webauth(session:bundle:)","title":"webAuth(session:bundle:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","role":"symbol"}}} \ No newline at end of file +{"metadata":{"symbolKind":"func","modules":[{"name":"Auth0"}],"externalID":"s:5Auth07webAuth7session6bundleAA03WebC0_pSo12NSURLSessionC_So8NSBundleCtF","title":"webAuth(session:bundle:)","roleHeading":"Function","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"webAuth","kind":"identifier"},{"text":"(","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier"}]},"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)"},"abstract":[{"type":"text","text":"Auth0 client for performing web-based authentication with "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"reference"},{"text":".","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth(session:bundle:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"webAuth","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":" = .shared, ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier","text":"Bundle"},{"text":" = Bundle.main) -> ","kind":"text"},{"text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"}]}],"kind":"declarations"},{"parameters":[{"name":"session","content":[{"inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"URLSession"},{"text":" instance used for networking. Defaults to ","type":"text"},{"type":"codeVoice","code":"URLSession.shared"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"bundle","content":[{"inlineContent":[{"text":"Bundle used to locate the ","type":"text"},{"type":"codeVoice","code":"Auth0.plist"},{"type":"text","text":" file. Defaults to "},{"code":"Bundle.main","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0 Web Auth client."}]}],"kind":"content"},{"content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0.webAuth()"]},{"inlineContent":[{"text":"The Auth0 Domain is loaded from the ","type":"text"},{"code":"Auth0.plist","type":"codeVoice"},{"type":"text","text":" file in your main bundle. It should have the following content:"}],"type":"paragraph"},{"type":"codeListing","code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"],"syntax":"xml"},{"style":"warning","name":"Warning","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Calling this method without a valid "},{"code":"Auth0.plist","type":"codeVoice"},{"text":" file will crash your application.","type":"text"}]}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"title":"Universal Login","type":"link","titleInlineContent":[{"type":"text","text":"Universal Login"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(session:bundle:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP"}],"url":"\/documentation\/auth0\/webauth(session:bundle:)","title":"webAuth(session:bundle:)","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Auth0 client for performing web-based authentication with "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},{"text":".","type":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth.json b/docs/data/documentation/auth0/webauth.json index 645e2d65..210c63d9 100644 --- a/docs/data/documentation/auth0/webauth.json +++ b/docs/data/documentation/auth0/webauth.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"roleHeading":"Protocol","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth","modules":[{"name":"Auth0"}],"symbolKind":"protocol","role":"symbol","externalID":"s:5Auth07WebAuthP"},"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:5Auth08LoggableP","text":"Loggable","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},{"kind":"text","text":", "},{"text":"Trackable","preciseIdentifier":"s:5Auth09TrackableP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","kind":"typeIdentifier"}]}]}],"relationshipsSections":[{"title":"Inherits From","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"kind":"relationships","type":"inheritsFrom"}],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"],"title":"Related Documentation"}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()"],"title":"Instance Methods"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"url":"\/documentation\/auth0\/telemetry","title":"Telemetry","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/invitationURL(_:)":{"required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invitationURL"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","title":"invitationURL(_:)","url":"\/documentation\/auth0\/webauth\/invitationurl(_:)","role":"symbol","abstract":[{"text":"Specify an invitation URL to join an organization.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"title":"clearSession(federated:)","required":true,"type":"topic","kind":"symbol","defaultImplementations":2,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/onClose(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/onclose(_:)","role":"symbol","type":"topic","kind":"symbol","title":"onClose(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"onClose","kind":"identifier"},{"text":"((() -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":")?) -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"type":"text","text":"Specify a callback to be called when the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" closes, while the flow continues with the code exchange.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connection(_:)":{"abstract":[{"text":"Specify an Auth0 connection to directly open that identity provider’s login page, skipping the Universal Login","type":"text"},{"text":" ","type":"text"},{"text":"page itself. By default no connection is specified, so the Universal Login page will be displayed.","type":"text"}],"title":"connection(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","url":"\/documentation\/auth0\/webauth\/connection(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"connection","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clientId":{"abstract":[{"text":"The Auth0 Client ID.","type":"text"}],"title":"clientId","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","url":"\/documentation\/auth0\/webauth\/clientid","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/nonce(_:)":{"abstract":[{"text":"Specify a ","type":"text"},{"code":"nonce","type":"codeVoice"},{"text":" parameter for ID token validation.","type":"text"}],"title":"nonce(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","url":"\/documentation\/auth0\/webauth\/nonce(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nonce","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/scope(_:)":{"role":"symbol","kind":"symbol","title":"scope(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","url":"\/documentation\/auth0\/webauth\/scope(_:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"text":"Specify the scopes that will be requested during authentication.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-98znq":{"role":"symbol","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","url":"\/documentation\/auth0\/webauth\/start()-98znq","title":"start()","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}],"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/parameters(_:)":{"required":true,"title":"parameters(_:)","role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webauth\/parameters(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","abstract":[{"type":"text","text":"Specify additional parameters for authentication."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/leeway(_:)":{"role":"symbol","kind":"symbol","title":"leeway(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)","url":"\/documentation\/auth0\/webauth\/leeway(_:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"leeway","kind":"identifier"},{"kind":"text","text":"("},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"text":"Specify a leeway amount for ID token validation.","type":"text"},{"text":" ","type":"text"},{"text":"This value represents the clock skew for the validation of date claims, for example ","type":"text"},{"code":"exp","type":"codeVoice"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Trackable"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"title":"Trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/organization(_:)":{"abstract":[{"text":"Specify an organization identifier to log in to.","type":"text"}],"title":"organization(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","url":"\/documentation\/auth0\/webauth\/organization(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"organization","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"title":"WebAuthUserAgent","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useHTTPS()":{"abstract":[{"text":"Use ","type":"text"},{"code":"https","type":"codeVoice"},{"text":" as the scheme for the redirect URL on iOS 17.4+ and macOS 14.4+. On older versions of iOS and","type":"text"},{"text":" ","type":"text"},{"text":"macOS, the bundle identifier of the app will be used as a custom scheme.","type":"text"}],"title":"useHTTPS()","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","url":"\/documentation\/auth0\/webauth\/usehttps()","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"useHTTPS","kind":"identifier"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connectionScope(_:)":{"abstract":[{"type":"text","text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google."}],"title":"connectionScope(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","url":"\/documentation\/auth0\/webauth\/connectionscope(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"connectionScope"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"url":"\/documentation\/auth0\/loggable","title":"Loggable","role":"symbol","type":"topic"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"title":"Universal Login","type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","titleInlineContent":[{"text":"Universal Login","type":"text"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/state(_:)":{"abstract":[{"text":"Specify a ","type":"text"},{"code":"state","type":"codeVoice"},{"text":" parameter that will be sent back after authentication to verify that the response","type":"text"},{"text":" ","type":"text"},{"text":"corresponds to your request.","type":"text"},{"type":"text","text":" "},{"text":"By default a random value is used.","type":"text"}],"title":"state(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","url":"\/documentation\/auth0\/webauth\/state(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"state","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"https://manage.auth0.com/#/apis":{"title":"Auth0 Dashboard","type":"link","identifier":"https:\/\/manage.auth0.com\/#\/apis","titleInlineContent":[{"text":"Auth0 Dashboard","type":"text"}],"url":"https:\/\/manage.auth0.com\/#\/apis"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"required":true,"kind":"symbol","abstract":[{"text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Using this method will disable single sign-on (SSO)."}],"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"useEphemeralSession","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/telemetry":{"abstract":[{"type":"text","text":"The "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"reference"},{"text":" instance.","type":"text"}],"title":"telemetry","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","url":"\/documentation\/auth0\/webauth\/telemetry","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/audience(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"audience","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"kind":"symbol","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Specify an audience name for the API that your application will call using the access token returned after"},{"text":" ","type":"text"},{"text":"authentication.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This value must match the "},{"type":"strong","inlineContent":[{"type":"text","text":"API Identifier"}]},{"text":" displayed in the APIs section of the ","type":"text"},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/apis","isActive":true},{"text":".","type":"text"}],"title":"audience(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/audience(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start(_:)":{"url":"\/documentation\/auth0\/webauth\/start(_:)","title":"start(_:)","kind":"symbol","abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"kind":"text","text":"(("},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/redirectURL(_:)":{"abstract":[{"text":"Specify a custom redirect URL to be used.","type":"text"}],"title":"redirectURL(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","url":"\/documentation\/auth0\/webauth\/redirecturl(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"redirectURL"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/maxAge(_:)":{"abstract":[{"type":"text","text":"Specify a "},{"code":"max_age","type":"codeVoice"},{"text":" parameter for authentication.","type":"text"},{"text":" ","type":"text"},{"text":"Sending this parameter will require the presence of the ","type":"text"},{"type":"codeVoice","code":"auth_time"},{"text":" claim in the ID token.","type":"text"}],"title":"maxAge(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","url":"\/documentation\/auth0\/webauth\/maxage(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"maxAge","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/issuer(_:)":{"abstract":[{"text":"Specify a custom issuer for ID token validation.","type":"text"},{"type":"text","text":" "},{"text":"This value will be used instead of the Auth0 Domain.","type":"text"}],"title":"issuer(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","url":"\/documentation\/auth0\/webauth\/issuer(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"issuer","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-qpqo":{"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"title":"start()","kind":"symbol","role":"symbol","type":"topic","required":true,"url":"\/documentation\/auth0\/webauth\/start()-qpqo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"provider","kind":"identifier"},{"kind":"text","text":"("},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"title":"provider(_:)","type":"topic","required":true,"url":"\/documentation\/auth0\/webauth\/provider(_:)","abstract":[{"type":"text","text":"Specify a custom Web Auth provider to use instead of the default "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/url":{"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"title":"url","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","url":"\/documentation\/auth0\/webauth\/url","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9xcu3":{"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"title":"clearSession(federated:callback:)","kind":"symbol","role":"symbol","type":"topic","required":true,"defaultImplementations":1,"url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"title":"clearSession(federated:)","required":true,"type":"topic","kind":"symbol","defaultImplementations":2,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"},{"text":" : ","kind":"text"},{"text":"Loggable","preciseIdentifier":"s:5Auth08LoggableP","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth09TrackableP","text":"Trackable","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"}],"platforms":["iOS"],"languages":["swift"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"},"relationshipsSections":[{"kind":"relationships","type":"inheritsFrom","title":"Inherits From","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url"]},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/authorizeURL(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()"]}],"kind":"symbol","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth"]}],"metadata":{"title":"WebAuth","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth07WebAuthP","roleHeading":"Protocol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"symbolKind":"protocol"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"],"title":"Related Documentation"}],"references":{"https://manage.auth0.com/#/apis":{"type":"link","identifier":"https:\/\/manage.auth0.com\/#\/apis","titleInlineContent":[{"type":"text","text":"Auth0 Dashboard"}],"title":"Auth0 Dashboard","url":"https:\/\/manage.auth0.com\/#\/apis"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"type":"text","text":" "},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-qpqo":{"url":"\/documentation\/auth0\/webauth\/start()-qpqo","required":true,"title":"start()","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"type":"topic","abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useHTTPS()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","title":"useHTTPS()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"useHTTPS","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Use "},{"type":"codeVoice","code":"https"},{"text":" as the scheme for the redirect URL on iOS 17.4+ and macOS 14.4+. On older versions of iOS and","type":"text"},{"type":"text","text":" "},{"text":"macOS, the bundle identifier of the app will be used as a custom scheme.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/usehttps()","role":"symbol","type":"topic","kind":"symbol","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/organization(_:)":{"abstract":[{"type":"text","text":"Specify an organization identifier to log in to."}],"required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"organization","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"url":"\/documentation\/auth0\/webauth\/organization(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","kind":"symbol","title":"organization(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connection(_:)":{"kind":"symbol","title":"connection(_:)","url":"\/documentation\/auth0\/webauth\/connection(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"connection","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"type":"topic","abstract":[{"type":"text","text":"Specify an Auth0 connection to directly open that identity provider’s login page, skipping the Universal Login"},{"text":" ","type":"text"},{"text":"page itself. By default no connection is specified, so the Universal Login page will be displayed.","type":"text"}],"required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/maxAge(_:)":{"required":true,"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"maxAge"},{"text":"(","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","url":"\/documentation\/auth0\/webauth\/maxage(_:)","title":"maxAge(_:)","abstract":[{"type":"text","text":"Specify a "},{"code":"max_age","type":"codeVoice"},{"text":" parameter for authentication.","type":"text"},{"type":"text","text":" "},{"text":"Sending this parameter will require the presence of the ","type":"text"},{"type":"codeVoice","code":"auth_time"},{"text":" claim in the ID token.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"defaultImplementations":2,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","title":"clearSession(federated:)","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","required":true,"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"navigatorTitle":[{"kind":"identifier","text":"Loggable"}],"abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"kind":"symbol","title":"Loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Loggable","kind":"identifier"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/loggable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/authorizeURL(_:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/authorizeURL(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authorizeURL","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Specify a custom authorize URL to be used."}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/webauth\/authorizeurl(_:)","kind":"symbol","title":"authorizeURL(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/state(_:)":{"type":"topic","url":"\/documentation\/auth0\/webauth\/state(_:)","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"state"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"type":"text","text":"Specify a "},{"type":"codeVoice","code":"state"},{"text":" parameter that will be sent back after authentication to verify that the response","type":"text"},{"text":" ","type":"text"},{"text":"corresponds to your request.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"By default a random value is used."}],"kind":"symbol","title":"state(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connectionScope(_:)":{"url":"\/documentation\/auth0\/webauth\/connectionscope(_:)","kind":"symbol","title":"connectionScope(_:)","role":"symbol","type":"topic","abstract":[{"text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"connectionScope"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","title":"Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"kind":"symbol","url":"\/documentation\/auth0\/telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"defaultImplementations":2,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","title":"clearSession(federated:)","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","required":true,"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/scope(_:)":{"type":"topic","url":"\/documentation\/auth0\/webauth\/scope(_:)","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"scope"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"type":"text","text":"Specify the scopes that will be requested during authentication."}],"kind":"symbol","title":"scope(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/parameters(_:)":{"abstract":[{"text":"Specify additional parameters for authentication.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/parameters(_:)","title":"parameters(_:)","type":"topic","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9xcu3":{"title":"clearSession(federated:callback:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">) -> "},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"required":true,"defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthUserAgent"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start(_:)":{"abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"required":true,"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"((","kind":"text"},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":")"}],"title":"start(_:)","kind":"symbol","url":"\/documentation\/auth0\/webauth\/start(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clientId":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webauth\/clientid","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The Auth0 Client ID."}],"title":"clientId","required":true},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/trackable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/leeway(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)","kind":"symbol","required":true,"title":"leeway(_:)","type":"topic","url":"\/documentation\/auth0\/webauth\/leeway(_:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"leeway","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"type":"text","text":"Specify a leeway amount for ID token validation."},{"type":"text","text":" "},{"type":"text","text":"This value represents the clock skew for the validation of date claims, for example "},{"type":"codeVoice","code":"exp"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/nonce(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","kind":"symbol","required":true,"title":"nonce(_:)","type":"topic","url":"\/documentation\/auth0\/webauth\/nonce(_:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"nonce"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"text":"Specify a ","type":"text"},{"type":"codeVoice","code":"nonce"},{"type":"text","text":" parameter for ID token validation."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/issuer(_:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webauth\/issuer(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"issuer"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"text":"Specify a custom issuer for ID token validation.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This value will be used instead of the Auth0 Domain."}],"title":"issuer(_:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/redirectURL(_:)":{"required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"redirectURL","kind":"identifier"},{"kind":"text","text":"("},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauth\/redirecturl(_:)","title":"redirectURL(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","abstract":[{"text":"Specify a custom redirect URL to be used.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-98znq":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","kind":"symbol","required":true,"title":"start()","type":"topic","url":"\/documentation\/auth0\/webauth\/start()-98znq","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"}],"abstract":[{"type":"text","text":"Starts the Web Auth flow."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/url":{"kind":"symbol","title":"url","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"type":"topic","abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"required":true,"role":"symbol","url":"\/documentation\/auth0\/webauth\/url"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","title":"provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"provider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","role":"symbol","type":"topic","kind":"symbol","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/telemetry":{"required":true,"abstract":[{"text":"The ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true},{"type":"text","text":" instance."}],"title":"telemetry","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","url":"\/documentation\/auth0\/webauth\/telemetry","type":"topic"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","titleInlineContent":[{"type":"text","text":"Universal Login"}],"title":"Universal Login","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/invitationURL(_:)":{"abstract":[{"type":"text","text":"Specify an invitation URL to join an organization."}],"required":true,"type":"topic","kind":"symbol","title":"invitationURL(_:)","role":"symbol","url":"\/documentation\/auth0\/webauth\/invitationurl(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"invitationURL"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/audience(_:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"audience","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol","required":true,"title":"audience(_:)","url":"\/documentation\/auth0\/webauth\/audience(_:)","abstract":[{"type":"text","text":"Specify an audience name for the API that your application will call using the access token returned after"},{"type":"text","text":" "},{"type":"text","text":"authentication."},{"type":"text","text":" "},{"text":"This value must match the ","type":"text"},{"type":"strong","inlineContent":[{"text":"API Identifier","type":"text"}]},{"text":" displayed in the APIs section of the ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis"},{"type":"text","text":"."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/onClose(_:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"onClose","kind":"identifier"},{"kind":"text","text":"((() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")?) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Specify a callback to be called when the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"type":"text","text":" closes, while the flow continues with the code exchange."}],"url":"\/documentation\/auth0\/webauth\/onclose(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","type":"topic","title":"onClose(_:)","required":true,"role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/audience(_:).json b/docs/data/documentation/auth0/webauth/audience(_:).json index 023cdb49..5b28bf30 100644 --- a/docs/data/documentation/auth0/webauth/audience(_:).json +++ b/docs/data/documentation/auth0/webauth/audience(_:).json @@ -1 +1 @@ -{"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"audience","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"title":"audience(_:)","externalID":"s:5Auth07WebAuthP8audienceyxSSF","required":true,"modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Method","symbolKind":"method"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"audience","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"audience"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Audience value. For example, "},{"type":"codeVoice","code":"https:\/\/example.com\/api"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"audience"}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"Specify an audience name for the API that your application will call using the access token returned after","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"authentication."},{"type":"text","text":" "},{"type":"text","text":"This value must match the "},{"inlineContent":[{"type":"text","text":"API Identifier"}],"type":"strong"},{"text":" displayed in the APIs section of the ","type":"text"},{"identifier":"https:\/\/manage.auth0.com\/#\/apis","type":"reference","isActive":true},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/audience(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"],"title":"Related Documentation"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"https://auth0.com/docs/secure/tokens/access-tokens/get-access-tokens#control-access-token-audience":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","titleInlineContent":[{"text":"Audience","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","type":"link","title":"Audience"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://manage.auth0.com/#/apis":{"identifier":"https:\/\/manage.auth0.com\/#\/apis","titleInlineContent":[{"type":"text","text":"Auth0 Dashboard"}],"url":"https:\/\/manage.auth0.com\/#\/apis","type":"link","title":"Auth0 Dashboard"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/audience(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"audience","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"kind":"symbol","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Specify an audience name for the API that your application will call using the access token returned after"},{"text":" ","type":"text"},{"text":"authentication.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This value must match the "},{"type":"strong","inlineContent":[{"type":"text","text":"API Identifier"}]},{"text":" displayed in the APIs section of the ","type":"text"},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/apis","isActive":true},{"text":".","type":"text"}],"title":"audience(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/audience(_:)"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"audience","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"audience","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}]}]},{"parameters":[{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Audience value. For example, "},{"code":"https:\/\/example.com\/api","type":"codeVoice"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/audience(_:)"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"required":true,"title":"audience(_:)","roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP8audienceyxSSF","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"audience"},{"kind":"text","text":"("},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]},"abstract":[{"type":"text","text":"Specify an audience name for the API that your application will call using the access token returned after"},{"text":" ","type":"text"},{"type":"text","text":"authentication."},{"text":" ","type":"text"},{"type":"text","text":"This value must match the "},{"type":"strong","inlineContent":[{"type":"text","text":"API Identifier"}]},{"text":" displayed in the APIs section of the ","type":"text"},{"identifier":"https:\/\/manage.auth0.com\/#\/apis","isActive":true,"type":"reference"},{"type":"text","text":"."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/audience(_:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"audience","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol","required":true,"title":"audience(_:)","url":"\/documentation\/auth0\/webauth\/audience(_:)","abstract":[{"type":"text","text":"Specify an audience name for the API that your application will call using the access token returned after"},{"type":"text","text":" "},{"type":"text","text":"authentication."},{"type":"text","text":" "},{"text":"This value must match the ","type":"text"},{"type":"strong","inlineContent":[{"text":"API Identifier","type":"text"}]},{"text":" displayed in the APIs section of the ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis"},{"type":"text","text":"."}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"https://auth0.com/docs/secure/tokens/access-tokens/get-access-tokens#control-access-token-audience":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","title":"Audience","titleInlineContent":[{"text":"Audience","type":"text"}]},"https://manage.auth0.com/#/apis":{"title":"Auth0 Dashboard","titleInlineContent":[{"type":"text","text":"Auth0 Dashboard"}],"type":"link","identifier":"https:\/\/manage.auth0.com\/#\/apis","url":"https:\/\/manage.auth0.com\/#\/apis"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/authorizeurl(_:).json b/docs/data/documentation/auth0/webauth/authorizeurl(_:).json new file mode 100644 index 00000000..b5341354 --- /dev/null +++ b/docs/data/documentation/auth0/webauth/authorizeurl(_:).json @@ -0,0 +1 @@ +{"abstract":[{"type":"text","text":"Specify a custom authorize URL to be used."}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/authorizeURL(_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"authorizeURL"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"authorizeURL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"authorizeURL","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Custom authorize URL."}]}]}],"kind":"parameters"},{"content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/authorizeurl(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"authorizeURL","kind":"identifier"},{"kind":"text","text":"("},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"externalID":"s:5Auth07WebAuthP12authorizeURLyx10Foundation0E0VF","role":"symbol","required":true,"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"authorizeURL(_:)","roleHeading":"Instance Method"},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/authorizeURL(_:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/authorizeURL(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authorizeURL","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Specify a custom authorize URL to be used."}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/webauth\/authorizeurl(_:)","kind":"symbol","title":"authorizeURL(_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/clearsession(federated:)-3k5r3.json b/docs/data/documentation/auth0/webauth/clearsession(federated:)-3k5r3.json index 7f145d3b..7bb9b380 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:)-3k5r3.json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:)-3k5r3.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3"]}],"kind":"symbol","metadata":{"title":"clearSession(federated:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"externalID":"s:5Auth07WebAuthPAAE12clearSession9federatedySb_tYaKF","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","symbolKind":"method","extendedModule":"Auth0"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr"],["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" = false) ","kind":"text"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"abstract":[],"title":"clearSession(federated:)","type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"title":"clearSession(federated:)","required":true,"type":"topic","kind":"symbol","defaultImplementations":2,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"title":"clearSession(federated:)","required":true,"type":"topic","kind":"symbol","defaultImplementations":2,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"title":"clearSession(federated:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"}],"role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthPAAE12clearSession9federatedySb_tYaKF"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":" = false) "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"}],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr"],["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"defaultImplementations":2,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","title":"clearSession(federated:)","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","required":true,"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","title":"clearSession(federated:)","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","role":"symbol","abstract":[],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"defaultImplementations":2,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","title":"clearSession(federated:)","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","required":true,"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/clearsession(federated:)-4zqyr.json b/docs/data/documentation/auth0/webauth/clearsession(federated:)-4zqyr.json index 355562ca..1fc3b5dd 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:)-4zqyr.json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:)-4zqyr.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr"},"metadata":{"symbolKind":"method","title":"clearSession(federated:)","required":true,"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth07WebAuthP12clearSession9federated7Combine12AnyPublisherVyytAA0bC5ErrorVGSb_tF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}]},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3"],"title":"WebAuth Implementations"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"federated","content":[{"type":"paragraph","inlineContent":[{"text":"If the identity provider session should be removed. Defaults to ","type":"text"},{"type":"codeVoice","code":"false"},{"text":".","type":"text"}]}]}]},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"A type-erased publisher.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"code":["Auth0"," .webAuth()"," .clearSession()"," .sink(receiveCompletion: { completion in"," switch completion {"," case .finished:"," print(\"Session cookie cleared\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: {})"," .store(in: &cancellables)"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"Remove both the Auth0 session and the identity provider session:","type":"text"}]},{"code":["Auth0"," .webAuth()"," .clearSession(federated: true)"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"],"type":"codeListing","syntax":"swift"},{"style":"note","type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"type":"text","text":" to have been added to the "},{"inlineContent":[{"text":"Allowed Logout URLs","type":"text"}],"type":"strong"},{"text":" field of your Auth0 application","type":"text"},{"type":"text","text":" "},{"type":"text","text":"settings in the "},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}]}]},{"type":"aside","name":"Note","style":"note","content":[{"inlineContent":[{"text":"You don’t need to call this method if you are using ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true},{"text":" on login, because there will","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"be no shared cookie to remove."}],"type":"paragraph"}]}]}],"sections":[],"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"required":true,"kind":"symbol","abstract":[{"text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Using this method will disable single sign-on (SSO)."}],"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"useEphemeralSession","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"kind":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","abstract":[],"title":"clearSession(federated:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"abstract":[],"title":"clearSession(federated:)","type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3"},"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"text":"Dashboard","type":"text"}],"title":"Dashboard","type":"link","url":"https:\/\/manage.auth0.com\/#\/applications\/"},"https://auth0.com/docs/authenticate/login/logout":{"title":"Logout","titleInlineContent":[{"type":"text","text":"Logout"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"title":"clearSession(federated:)","required":true,"type":"topic","kind":"symbol","defaultImplementations":2,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"defaultImplementationsSections":[{"title":"WebAuth Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"code":"false","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"federated"}]},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A type-erased publisher."}]}]},{"kind":"content","content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .clearSession()"," .sink(receiveCompletion: { completion in"," switch completion {"," case .finished:"," print(\"Session cookie cleared\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: {})"," .store(in: &cancellables)"]},{"inlineContent":[{"type":"text","text":"Remove both the Auth0 session and the identity provider session:"}],"type":"paragraph"},{"type":"codeListing","code":["Auth0"," .webAuth()"," .clearSession(federated: true)"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"],"syntax":"swift"},{"name":"Requires","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"Callback URL"}]},{"text":" to have been added to the ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"Allowed Logout URLs"}]},{"type":"text","text":" field of your Auth0 application"},{"type":"text","text":" "},{"text":"settings in the ","type":"text"},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference","isActive":true},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","type":"aside"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true},{"text":" on login, because there will","type":"text"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}]}],"name":"Note","type":"aside","style":"note"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr"]}],"sections":[],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr"},"metadata":{"symbolKind":"method","title":"clearSession(federated:)","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"role":"symbol","externalID":"s:5Auth07WebAuthP12clearSession9federated7Combine12AnyPublisherVyytAA0bC5ErrorVGSb_tF"},"references":{"https://auth0.com/docs/authenticate/login/logout":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","titleInlineContent":[{"type":"text","text":"Logout"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","title":"Logout"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"title":"clearSession(federated:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","abstract":[],"role":"symbol","type":"topic"},"https://manage.auth0.com/#/applications/":{"type":"link","title":"Dashboard","titleInlineContent":[{"text":"Dashboard","type":"text"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"defaultImplementations":2,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","title":"clearSession(federated:)","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","required":true,"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"type":"text","text":" "},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","title":"clearSession(federated:)","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","role":"symbol","abstract":[],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/clearsession(federated:)-6n4z6.json b/docs/data/documentation/auth0/webauth/clearsession(federated:)-6n4z6.json index ac01a7e9..b78a9d67 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:)-6n4z6.json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:)-6n4z6.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":">"}],"extendedModule":"Auth0","symbolKind":"method","title":"clearSession(federated:)","roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthPAAE12clearSession9federated7Combine12AnyPublisherVyytAA0bC5ErrorVGSb_tF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr"],["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":" = false) -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":", ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"title":"clearSession(federated:)","required":true,"type":"topic","kind":"symbol","defaultImplementations":2,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"title":"clearSession(federated:)","required":true,"type":"topic","kind":"symbol","defaultImplementations":2,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"kind":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","abstract":[],"title":"clearSession(federated:)"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6"},"sections":[],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6"]}],"metadata":{"title":"clearSession(federated:)","modules":[{"name":"Auth0"}],"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthPAAE12clearSession9federated7Combine12AnyPublisherVyytAA0bC5ErrorVGSb_tF","extendedModule":"Auth0","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"kind":"text","text":">"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":" = false) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":", ","kind":"text"},{"text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr"],["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"title":"clearSession(federated:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","abstract":[],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"defaultImplementations":2,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","title":"clearSession(federated:)","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","required":true,"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"defaultImplementations":2,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","title":"clearSession(federated:)","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","required":true,"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/clearsession(federated:)-8sl1o.json b/docs/data/documentation/auth0/webauth/clearsession(federated:)-8sl1o.json index df3b6cd4..b08f4717 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:)-8sl1o.json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:)-8sl1o.json @@ -1 +1 @@ -{"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"role":"symbol","symbolKind":"method","title":"clearSession(federated:)","modules":[{"name":"Auth0"}],"required":true,"externalID":"s:5Auth07WebAuthP12clearSession9federatedySb_tYaKF","roleHeading":"Instance Method"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}]}]},{"kind":"parameters","parameters":[{"name":"federated","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"type":"codeVoice","code":"false"},{"type":"text","text":"."}]}]}]},{"content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"code":["do {"," try await Auth0.webAuth().clearSession()"," print(\"Session cookie cleared\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"syntax":"swift","type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Remove both the Auth0 session and the identity provider session:"}]},{"type":"codeListing","syntax":"swift","code":["try await Auth0.webAuth().clearSession(federated: true)"]},{"style":"note","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"text":"Callback URL","type":"text"}],"type":"strong"},{"text":" to have been added to the ","type":"text"},{"inlineContent":[{"text":"Allowed Logout URLs","type":"text"}],"type":"strong"},{"type":"text","text":" field of your Auth0 application"},{"type":"text","text":" "},{"type":"text","text":"settings in the "},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside"},{"name":"Note","content":[{"inlineContent":[{"text":"You don’t need to call this method if you are using ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},{"text":" on login, because there will","type":"text"},{"type":"text","text":" "},{"text":"be no shared cookie to remove.","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note"}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6"],"title":"WebAuth Implementations"}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"title":"clearSession(federated:)","required":true,"type":"topic","kind":"symbol","defaultImplementations":2,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"https://auth0.com/docs/authenticate/login/logout":{"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","titleInlineContent":[{"text":"Logout","type":"text"}],"title":"Logout","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"abstract":[],"title":"clearSession(federated:)","type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"kind":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","abstract":[],"title":"clearSession(federated:)"},"https://manage.auth0.com/#/applications/":{"url":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"type":"text","text":"Dashboard"}],"title":"Dashboard","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"required":true,"kind":"symbol","abstract":[{"text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Using this method will disable single sign-on (SSO)."}],"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"useEphemeralSession","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"defaultImplementationsSections":[{"title":"WebAuth Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"metadata":{"title":"clearSession(federated:)","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"modules":[{"name":"Auth0"}],"required":true,"externalID":"s:5Auth07WebAuthP12clearSession9federatedySb_tYaKF","role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"federated","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"code":"false","type":"codeVoice"},{"text":".","type":"text"}]}]}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"type":"codeListing","syntax":"swift","code":["do {"," try await Auth0.webAuth().clearSession()"," print(\"Session cookie cleared\")","} catch {"," print(\"Failed with: \\(error)\")","}"]},{"type":"paragraph","inlineContent":[{"text":"Remove both the Auth0 session and the identity provider session:","type":"text"}]},{"code":["try await Auth0.webAuth().clearSession(federated: true)"],"type":"codeListing","syntax":"swift"},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"type":"text","text":" to have been added to the "},{"type":"strong","inlineContent":[{"text":"Allowed Logout URLs","type":"text"}]},{"type":"text","text":" field of your Auth0 application"},{"type":"text","text":" "},{"text":"settings in the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}]}],"style":"note","type":"aside"},{"type":"aside","content":[{"inlineContent":[{"text":"You don’t need to call this method if you are using ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true,"type":"reference"},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}],"type":"paragraph"}],"name":"Note","style":"note"}],"kind":"content"}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","title":"clearSession(federated:)","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","role":"symbol","abstract":[],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") "},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"}],"kind":"symbol"},"https://auth0.com/docs/authenticate/login/logout":{"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","title":"Logout","titleInlineContent":[{"type":"text","text":"Logout"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"title":"clearSession(federated:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","abstract":[],"role":"symbol","type":"topic"},"https://manage.auth0.com/#/applications/":{"url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard","titleInlineContent":[{"type":"text","text":"Dashboard"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"defaultImplementations":2,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","title":"clearSession(federated:)","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","required":true,"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"type":"text","text":" "},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/clearsession(federated:callback:)-9xcu3.json b/docs/data/documentation/auth0/webauth/clearsession(federated:callback:)-9xcu3.json index 25514f1a..cd6279be 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:callback:)-9xcu3.json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:callback:)-9xcu3.json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61"],"title":"WebAuth Implementations"}],"metadata":{"required":true,"title":"clearSession(federated:callback:)","role":"symbol","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")","kind":"text"}],"externalID":"s:5Auth07WebAuthP12clearSession9federated8callbackySb_ys6ResultOyytAA0bC5ErrorVGctF","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": "},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"languages":["swift"]}]},{"parameters":[{"name":"federated","content":[{"inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"type":"codeVoice","code":"false"},{"text":".","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Callback that receives a "},{"code":"Result","type":"codeVoice"},{"text":" containing either an empty success case or an error.","type":"text"}],"type":"paragraph"}],"name":"callback"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Usage","anchor":"Usage","level":2,"type":"heading"},{"syntax":"swift","code":["Auth0"," .webAuth()"," .clearSession { result in"," switch result {"," case .success:"," print(\"Session cookie cleared\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"Remove both the Auth0 session and the identity provider session:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .clearSession(federated: true) { print($0) }"]},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"strong","inlineContent":[{"text":"Callback URL","type":"text"}]},{"text":" to have been added to the ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"Allowed Logout URLs"}]},{"text":" field of your Auth0 application","type":"text"},{"type":"text","text":" "},{"type":"text","text":"settings in the "},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"text":".","type":"text"}]}],"type":"aside","style":"note"},{"type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","type":"reference","isActive":true},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}]}],"name":"Note"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"https://auth0.com/docs/authenticate/login/logout":{"type":"link","titleInlineContent":[{"text":"Logout","type":"text"}],"title":"Logout","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://manage.auth0.com/#/applications/":{"type":"link","titleInlineContent":[{"type":"text","text":"Dashboard"}],"title":"Dashboard","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","url":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"required":true,"kind":"symbol","abstract":[{"text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Using this method will disable single sign-on (SSO)."}],"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"useEphemeralSession","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"url":"\/documentation\/auth0\/webauthresult","role":"symbol","title":"WebAuthResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthResult"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9xcu3":{"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"title":"clearSession(federated:callback:)","kind":"symbol","role":"symbol","type":"topic","required":true,"defaultImplementations":1,"url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"kind":"symbol","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","title":"clearSession(federated:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","type":"topic","role":"symbol"}}} \ No newline at end of file +{"metadata":{"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")","kind":"text"}],"required":true,"role":"symbol","externalID":"s:5Auth07WebAuthP12clearSession9federated8callbackySb_ys6ResultOyytAA0bC5ErrorVGctF","modules":[{"name":"Auth0"}],"title":"clearSession(federated:callback:)","symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"],"title":"Related Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61"],"title":"WebAuth Implementations"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": "},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","text":"WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"code":"false","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"federated"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Callback that receives a ","type":"text"},{"type":"codeVoice","code":"Result"},{"type":"text","text":" containing either an empty success case or an error."}]}],"name":"callback"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .webAuth()"," .clearSession { result in"," switch result {"," case .success:"," print(\"Session cookie cleared\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"]},{"inlineContent":[{"type":"text","text":"Remove both the Auth0 session and the identity provider session:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .clearSession(federated: true) { print($0) }"]},{"content":[{"inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"type":"text","text":" to have been added to the "},{"type":"strong","inlineContent":[{"type":"text","text":"Allowed Logout URLs"}]},{"text":" field of your Auth0 application","type":"text"},{"type":"text","text":" "},{"text":"settings in the ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","name":"Requires","style":"note"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true},{"text":" on login, because there will","type":"text"},{"type":"text","text":" "},{"text":"be no shared cookie to remove.","type":"text"}]}],"type":"aside","name":"Note"}],"kind":"content"}],"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3"},"sections":[],"references":{"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"type":"text","text":"Dashboard"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","title":"Dashboard"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"title":"clearSession(federated:callback:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9xcu3":{"title":"clearSession(federated:callback:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">) -> "},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"required":true,"defaultImplementations":1},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"type":"text","text":" "},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"required":true},"https://auth0.com/docs/authenticate/login/logout":{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","titleInlineContent":[{"type":"text","text":"Logout"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","type":"link","title":"Logout"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/clearsession(federated:callback:)-9yv61.json b/docs/data/documentation/auth0/webauth/clearsession(federated:callback:)-9yv61.json index 0368a6fa..da949815 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:callback:)-9yv61.json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:callback:)-9yv61.json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"metadata":{"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","role":"symbol","symbolKind":"method","roleHeading":"Instance Method","title":"clearSession(federated:callback:)","externalID":"s:5Auth07WebAuthPAAE12clearSession9federated8callbackySb_ys6ResultOyytAA0bC5ErrorVGctF","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"text":"callback","kind":"externalParam"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":" = false, "},{"kind":"externalParam","text":"callback"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"code":"false","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"federated"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Callback that receives a "},{"code":"Result","type":"codeVoice"},{"type":"text","text":" containing either an empty success case or an error."}]}],"name":"callback"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"type":"codeListing","code":["Auth0"," .webAuth()"," .clearSession { result in"," switch result {"," case .success:"," print(\"Session cookie cleared\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Remove both the Auth0 session and the identity provider session:"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .clearSession(federated: true) { print($0) }"]},{"name":"Requires","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"strong","inlineContent":[{"text":"Callback URL","type":"text"}]},{"type":"text","text":" to have been added to the "},{"inlineContent":[{"type":"text","text":"Allowed Logout URLs"}],"type":"strong"},{"type":"text","text":" field of your Auth0 application"},{"type":"text","text":" "},{"text":"settings in the ","type":"text"},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true,"type":"reference"},{"type":"text","text":"."}]}]},{"type":"aside","style":"note","name":"Note","content":[{"inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true},{"text":" on login, because there will","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"be no shared cookie to remove."}],"type":"paragraph"}]}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61"]}],"references":{"https://auth0.com/docs/authenticate/login/logout":{"titleInlineContent":[{"type":"text","text":"Logout"}],"type":"link","title":"Logout","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"required":true,"kind":"symbol","abstract":[{"text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Using this method will disable single sign-on (SSO)."}],"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"useEphemeralSession","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"kind":"symbol","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","title":"clearSession(federated:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"https://manage.auth0.com/#/applications/":{"type":"link","title":"Dashboard","titleInlineContent":[{"type":"text","text":"Dashboard"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"url":"\/documentation\/auth0\/webauthresult","role":"symbol","title":"WebAuthResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthResult"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9xcu3":{"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"title":"clearSession(federated:callback:)","kind":"symbol","role":"symbol","type":"topic","required":true,"defaultImplementations":1,"url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}]}}} \ No newline at end of file +{"metadata":{"role":"symbol","title":"clearSession(federated:callback:)","externalID":"s:5Auth07WebAuthPAAE12clearSession9federated8callbackySb_ys6ResultOyytAA0bC5ErrorVGctF","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"],"title":"Related Documentation"}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61"]}],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" = false, ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"federated","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"type":"codeVoice","code":"false"},{"type":"text","text":"."}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Callback that receives a "},{"type":"codeVoice","code":"Result"},{"type":"text","text":" containing either an empty success case or an error."}],"type":"paragraph"}],"name":"callback"}],"kind":"parameters"},{"content":[{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .clearSession { result in"," switch result {"," case .success:"," print(\"Session cookie cleared\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Remove both the Auth0 session and the identity provider session:"}]},{"syntax":"swift","type":"codeListing","code":["Auth0"," .webAuth()"," .clearSession(federated: true) { print($0) }"]},{"type":"aside","name":"Requires","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"text":"Callback URL","type":"text"}],"type":"strong"},{"text":" to have been added to the ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"Allowed Logout URLs"}]},{"type":"text","text":" field of your Auth0 application"},{"type":"text","text":" "},{"type":"text","text":"settings in the "},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true},{"text":".","type":"text"}]}]},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},{"text":" on login, because there will","type":"text"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}]}],"name":"Note","style":"note"}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"title":"clearSession(federated:callback:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}]},"https://auth0.com/docs/authenticate/login/logout":{"titleInlineContent":[{"type":"text","text":"Logout"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","title":"Logout"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"type":"text","text":" "},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9xcu3":{"title":"clearSession(federated:callback:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">) -> "},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9xcu3","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"required":true,"defaultImplementations":1},"https://manage.auth0.com/#/applications/":{"title":"Dashboard","titleInlineContent":[{"type":"text","text":"Dashboard"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/clientid.json b/docs/data/documentation/auth0/webauth/clientid.json index 83fde34f..45505e02 100644 --- a/docs/data/documentation/auth0/webauth/clientid.json +++ b/docs/data/documentation/auth0/webauth/clientid.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"externalID":"s:5Auth07WebAuthP8clientIdSSvp","symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"clientId"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId"},"abstract":[{"type":"text","text":"The Auth0 Client ID."}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/clientid"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clientId":{"abstract":[{"text":"The Auth0 Client ID.","type":"text"}],"title":"clientId","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","url":"\/documentation\/auth0\/webauth\/clientid","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clientid"]}],"metadata":{"roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:5Auth07WebAuthP8clientIdSSvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"modules":[{"name":"Auth0"}],"title":"clientId","required":true},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"type":"text","text":"The Auth0 Client ID."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"clientId","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clientId":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webauth\/clientid","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The Auth0 Client ID."}],"title":"clientId","required":true}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/connection(_:).json b/docs/data/documentation/auth0/webauth/connection(_:).json index b6efb8c5..171f0048 100644 --- a/docs/data/documentation/auth0/webauth/connection(_:).json +++ b/docs/data/documentation/auth0/webauth/connection(_:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"modules":[{"name":"Auth0"}],"title":"connection(_:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"connection"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP10connectionyxSSF","symbolKind":"method"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"connection","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"connection","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the connection. For example, ","type":"text"},{"code":"github","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"connection"}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}]}],"kind":"symbol","abstract":[{"type":"text","text":"Specify an Auth0 connection to directly open that identity provider’s login page, skipping the Universal Login"},{"type":"text","text":" "},{"text":"page itself. By default no connection is specified, so the Universal Login page will be displayed.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/connection(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connection(_:)":{"abstract":[{"text":"Specify an Auth0 connection to directly open that identity provider’s login page, skipping the Universal Login","type":"text"},{"text":" ","type":"text"},{"text":"page itself. By default no connection is specified, so the Universal Login page will be displayed.","type":"text"}],"title":"connection(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","url":"\/documentation\/auth0\/webauth\/connection(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"connection","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]}}} \ No newline at end of file +{"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"Specify an Auth0 connection to directly open that identity provider’s login page, skipping the Universal Login"},{"type":"text","text":" "},{"text":"page itself. By default no connection is specified, so the Universal Login page will be displayed.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/connection(_:)"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"connection"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection. For example, "},{"type":"codeVoice","code":"github"},{"type":"text","text":"."}]}],"name":"connection"}]},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"metadata":{"roleHeading":"Instance Method","required":true,"symbolKind":"method","externalID":"s:5Auth07WebAuthP10connectionyxSSF","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"connection","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol","title":"connection(_:)"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connection(_:)":{"kind":"symbol","title":"connection(_:)","url":"\/documentation\/auth0\/webauth\/connection(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"connection","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"type":"topic","abstract":[{"type":"text","text":"Specify an Auth0 connection to directly open that identity provider’s login page, skipping the Universal Login"},{"text":" ","type":"text"},{"text":"page itself. By default no connection is specified, so the Universal Login page will be displayed.","type":"text"}],"required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/connectionscope(_:).json b/docs/data/documentation/auth0/webauth/connectionscope(_:).json index 93e57f6f..b0c557e1 100644 --- a/docs/data/documentation/auth0/webauth/connectionscope(_:).json +++ b/docs/data/documentation/auth0/webauth/connectionscope(_:).json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","required":true,"externalID":"s:5Auth07WebAuthP15connectionScopeyxSSF","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"connectionScope","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"title":"connectionScope(_:)","roleHeading":"Instance Method"},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"abstract":[{"type":"text","text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"connectionScope"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"connectionScope","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]}],"kind":"declarations"},{"parameters":[{"name":"connectionScope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested OAuth2\/social scope values. For example,"},{"text":" ","type":"text"},{"type":"codeVoice","code":"public_repo read:user"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/identity-providers\/adding-scopes-for-an-external-idp"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/connectionscope(_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/authenticate/identity-providers/adding-scopes-for-an-external-idp":{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/identity-providers\/adding-scopes-for-an-external-idp","type":"link","titleInlineContent":[{"type":"text","text":"Connection Scopes"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/identity-providers\/adding-scopes-for-an-external-idp","title":"Connection Scopes"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connectionScope(_:)":{"abstract":[{"type":"text","text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google."}],"title":"connectionScope(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","url":"\/documentation\/auth0\/webauth\/connectionscope(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"connectionScope"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/identity-providers\/adding-scopes-for-an-external-idp"]}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/connectionscope(_:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"connectionScope(_:)","externalID":"s:5Auth07WebAuthP15connectionScopeyxSSF","symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"connectionScope","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol","required":true,"roleHeading":"Instance Method"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"connectionScope","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"connectionScope","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"connectionScope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested OAuth2\/social scope values. For example,"},{"type":"text","text":" "},{"code":"public_repo read:user","type":"codeVoice"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"abstract":[{"text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connectionScope(_:)":{"url":"\/documentation\/auth0\/webauth\/connectionscope(_:)","kind":"symbol","title":"connectionScope(_:)","role":"symbol","type":"topic","abstract":[{"text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"connectionScope"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"https://auth0.com/docs/authenticate/identity-providers/adding-scopes-for-an-external-idp":{"title":"Connection Scopes","identifier":"https:\/\/auth0.com\/docs\/authenticate\/identity-providers\/adding-scopes-for-an-external-idp","type":"link","titleInlineContent":[{"type":"text","text":"Connection Scopes"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/identity-providers\/adding-scopes-for-an-external-idp"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/invitationurl(_:).json b/docs/data/documentation/auth0/webauth/invitationurl(_:).json index 16df9b4e..a10b1fb0 100644 --- a/docs/data/documentation/auth0/webauth/invitationurl(_:).json +++ b/docs/data/documentation/auth0/webauth/invitationurl(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invitationURL"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"invitationURL"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Invitation URL for the organization.","type":"text"}],"type":"paragraph"}],"name":"invitationURL"}]},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}]}]}],"metadata":{"externalID":"s:5Auth07WebAuthP13invitationURLyx10Foundation0E0VF","title":"invitationURL(_:)","role":"symbol","required":true,"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invitationURL"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webauth\/invitationurl(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"type":"text","text":"Specify an invitation URL to join an organization."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/invitationURL(_:)":{"required":true,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invitationURL"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","title":"invitationURL(_:)","url":"\/documentation\/auth0\/webauth\/invitationurl(_:)","role":"symbol","abstract":[{"text":"Specify an invitation URL to join an organization.","type":"text"}]}}} \ No newline at end of file +{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/invitationurl(_:)"]}],"abstract":[{"text":"Specify an invitation URL to join an organization.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invitationURL"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"invitationURL","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Invitation URL for the organization."}]}],"name":"invitationURL"}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"required":true,"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"invitationURL","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"externalID":"s:5Auth07WebAuthP13invitationURLyx10Foundation0E0VF","title":"invitationURL(_:)","roleHeading":"Instance Method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/invitationURL(_:)":{"abstract":[{"type":"text","text":"Specify an invitation URL to join an organization."}],"required":true,"type":"topic","kind":"symbol","title":"invitationURL(_:)","role":"symbol","url":"\/documentation\/auth0\/webauth\/invitationurl(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"invitationURL"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/issuer(_:).json b/docs/data/documentation/auth0/webauth/issuer(_:).json index 4a277692..d8a1ce07 100644 --- a/docs/data/documentation/auth0/webauth/issuer(_:).json +++ b/docs/data/documentation/auth0/webauth/issuer(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"issuer"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"issuer","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]}]},{"parameters":[{"name":"issuer","content":[{"inlineContent":[{"type":"text","text":"Custom issuer value. For example, "},{"type":"codeVoice","code":"https:\/\/example.com\/"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/issuer(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"abstract":[{"text":"Specify a custom issuer for ID token validation.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This value will be used instead of the Auth0 Domain."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"kind":"symbol","metadata":{"symbolKind":"method","required":true,"role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"issuer"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"externalID":"s:5Auth07WebAuthP6issueryxSSF","roleHeading":"Instance Method","title":"issuer(_:)"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/issuer(_:)":{"abstract":[{"text":"Specify a custom issuer for ID token validation.","type":"text"},{"type":"text","text":" "},{"text":"This value will be used instead of the Auth0 Domain.","type":"text"}],"title":"issuer(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","url":"\/documentation\/auth0\/webauth\/issuer(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"issuer","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]}}} \ No newline at end of file +{"metadata":{"required":true,"modules":[{"name":"Auth0"}],"symbolKind":"method","externalID":"s:5Auth07WebAuthP6issueryxSSF","role":"symbol","roleHeading":"Instance Method","title":"issuer(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"issuer"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]},"abstract":[{"text":"Specify a custom issuer for ID token validation.","type":"text"},{"type":"text","text":" "},{"text":"This value will be used instead of the Auth0 Domain.","type":"text"}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"issuer","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"issuer","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}]}]},{"kind":"parameters","parameters":[{"name":"issuer","content":[{"inlineContent":[{"type":"text","text":"Custom issuer value. For example, "},{"type":"codeVoice","code":"https:\/\/example.com\/"},{"type":"text","text":"."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/issuer(_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/issuer(_:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webauth\/issuer(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"issuer"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"text":"Specify a custom issuer for ID token validation.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This value will be used instead of the Auth0 Domain."}],"title":"issuer(_:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/leeway(_:).json b/docs/data/documentation/auth0/webauth/leeway(_:).json index 4c022214..a556de5c 100644 --- a/docs/data/documentation/auth0/webauth/leeway(_:).json +++ b/docs/data/documentation/auth0/webauth/leeway(_:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Specify a leeway amount for ID token validation."},{"text":" ","type":"text"},{"text":"This value represents the clock skew for the validation of date claims, for example ","type":"text"},{"type":"codeVoice","code":"exp"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"leeway","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"leeway","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]}]},{"kind":"parameters","parameters":[{"name":"leeway","content":[{"inlineContent":[{"text":"Number of milliseconds. Defaults to ","type":"text"},{"code":"60_000","type":"codeVoice"},{"type":"text","text":" (1 minute)."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)"},"metadata":{"externalID":"s:5Auth07WebAuthP6leewayyxSiF","modules":[{"name":"Auth0"}],"required":true,"title":"leeway(_:)","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"leeway"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"roleHeading":"Instance Method","role":"symbol"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/leeway(_:)"]}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/leeway(_:)":{"role":"symbol","kind":"symbol","title":"leeway(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)","url":"\/documentation\/auth0\/webauth\/leeway(_:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"leeway","kind":"identifier"},{"kind":"text","text":"("},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"text":"Specify a leeway amount for ID token validation.","type":"text"},{"text":" ","type":"text"},{"text":"This value represents the clock skew for the validation of date claims, for example ","type":"text"},{"code":"exp","type":"codeVoice"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"}}} \ No newline at end of file +{"sections":[],"abstract":[{"text":"Specify a leeway amount for ID token validation.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This value represents the clock skew for the validation of date claims, for example "},{"type":"codeVoice","code":"exp"},{"type":"text","text":"."}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"leeway","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"leeway"},{"kind":"text","text":": "},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"leeway","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Number of milliseconds. Defaults to "},{"code":"60_000","type":"codeVoice"},{"text":" (1 minute).","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}]}]}],"metadata":{"title":"leeway(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"leeway","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"role":"symbol","externalID":"s:5Auth07WebAuthP6leewayyxSiF","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}]},"variants":[{"paths":["\/documentation\/auth0\/webauth\/leeway(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/leeway(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)","kind":"symbol","required":true,"title":"leeway(_:)","type":"topic","url":"\/documentation\/auth0\/webauth\/leeway(_:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"leeway","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"type":"text","text":"Specify a leeway amount for ID token validation."},{"type":"text","text":" "},{"type":"text","text":"This value represents the clock skew for the validation of date claims, for example "},{"type":"codeVoice","code":"exp"},{"text":".","type":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/maxage(_:).json b/docs/data/documentation/auth0/webauth/maxage(_:).json index fa84fd2e..407f5383 100644 --- a/docs/data/documentation/auth0/webauth/maxage(_:).json +++ b/docs/data/documentation/auth0/webauth/maxage(_:).json @@ -1 +1 @@ -{"metadata":{"title":"maxAge(_:)","modules":[{"name":"Auth0"}],"required":true,"role":"symbol","roleHeading":"Instance Method","symbolKind":"method","externalID":"s:5Auth07WebAuthP6maxAgeyxSiF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"maxAge","kind":"identifier"},{"kind":"text","text":"("},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Specify a "},{"type":"codeVoice","code":"max_age"},{"type":"text","text":" parameter for authentication."},{"type":"text","text":" "},{"text":"Sending this parameter will require the presence of the ","type":"text"},{"code":"auth_time","type":"codeVoice"},{"type":"text","text":" claim in the ID token."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/maxage(_:)"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"maxAge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"maxAge","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Number of milliseconds."}]}],"name":"maxAge"}]},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/maxAge(_:)":{"abstract":[{"type":"text","text":"Specify a "},{"code":"max_age","type":"codeVoice"},{"text":" parameter for authentication.","type":"text"},{"text":" ","type":"text"},{"text":"Sending this parameter will require the presence of the ","type":"text"},{"type":"codeVoice","code":"auth_time"},{"text":" claim in the ID token.","type":"text"}],"title":"maxAge(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","url":"\/documentation\/auth0\/webauth\/maxage(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"maxAge","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/webauth\/maxage(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"maxAge(_:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"maxAge","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"symbolKind":"method","externalID":"s:5Auth07WebAuthP6maxAgeyxSiF","required":true,"roleHeading":"Instance Method","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"maxAge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"maxAge"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Number of milliseconds."}]}],"name":"maxAge"}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"Specify a "},{"type":"codeVoice","code":"max_age"},{"text":" parameter for authentication.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Sending this parameter will require the presence of the "},{"code":"auth_time","type":"codeVoice"},{"type":"text","text":" claim in the ID token."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/maxAge(_:)":{"required":true,"role":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"maxAge"},{"text":"(","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","url":"\/documentation\/auth0\/webauth\/maxage(_:)","title":"maxAge(_:)","abstract":[{"type":"text","text":"Specify a "},{"code":"max_age","type":"codeVoice"},{"text":" parameter for authentication.","type":"text"},{"type":"text","text":" "},{"text":"Sending this parameter will require the presence of the ","type":"text"},{"type":"codeVoice","code":"auth_time"},{"text":" claim in the ID token.","type":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/nonce(_:).json b/docs/data/documentation/auth0/webauth/nonce(_:).json index e8f877de..65b81c44 100644 --- a/docs/data/documentation/auth0/webauth/nonce(_:).json +++ b/docs/data/documentation/auth0/webauth/nonce(_:).json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"type":"text","text":"Specify a "},{"code":"nonce","type":"codeVoice"},{"type":"text","text":" parameter for ID token validation."}],"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"nonce"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"nonce","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"nonce","content":[{"type":"paragraph","inlineContent":[{"text":"Nonce value.","type":"text"}]}]}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"required":true,"externalID":"s:5Auth07WebAuthP5nonceyxSSF","title":"nonce(_:)","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"nonce"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/nonce(_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/nonce(_:)":{"abstract":[{"text":"Specify a ","type":"text"},{"code":"nonce","type":"codeVoice"},{"text":" parameter for ID token validation.","type":"text"}],"title":"nonce(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","url":"\/documentation\/auth0\/webauth\/nonce(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nonce","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"}}} \ No newline at end of file +{"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"nonce","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"nonce","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Nonce value.","type":"text"}],"type":"paragraph"}],"name":"nonce"}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Specify a "},{"type":"codeVoice","code":"nonce"},{"type":"text","text":" parameter for ID token validation."}],"metadata":{"externalID":"s:5Auth07WebAuthP5nonceyxSSF","required":true,"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","role":"symbol","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"nonce","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"title":"nonce(_:)"},"variants":[{"paths":["\/documentation\/auth0\/webauth\/nonce(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/nonce(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","kind":"symbol","required":true,"title":"nonce(_:)","type":"topic","url":"\/documentation\/auth0\/webauth\/nonce(_:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"nonce"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"text":"Specify a ","type":"text"},{"type":"codeVoice","code":"nonce"},{"type":"text","text":" parameter for ID token validation."}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/onclose(_:).json b/docs/data/documentation/auth0/webauth/onclose(_:).json index 29b8a0f4..e984da96 100644 --- a/docs/data/documentation/auth0/webauth/onclose(_:).json +++ b/docs/data/documentation/auth0/webauth/onclose(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"onClose","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"callback","kind":"internalParam"},{"text":": (() -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")?) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"callback","content":[{"inlineContent":[{"text":"A callback to be executed","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"sections":[],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/onclose(_:)"]}],"abstract":[{"type":"text","text":"Specify a callback to be called when the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},{"text":" closes, while the flow continues with the code exchange.","type":"text"}],"metadata":{"title":"onClose(_:)","required":true,"role":"symbol","symbolKind":"method","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"onClose","kind":"identifier"},{"text":"((() -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")?) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"externalID":"s:5Auth07WebAuthP7onCloseyxyycSgF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/onClose(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","required":true,"url":"\/documentation\/auth0\/webauth\/onclose(_:)","role":"symbol","type":"topic","kind":"symbol","title":"onClose(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"onClose","kind":"identifier"},{"text":"((() -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"kind":"text","text":")?) -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"type":"text","text":"Specify a callback to be called when the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" closes, while the flow continues with the code exchange.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"title":"WebAuthUserAgent","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Specify a callback to be called when the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"type":"text","text":" closes, while the flow continues with the code exchange."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/onclose(_:)"]}],"sections":[],"metadata":{"externalID":"s:5Auth07WebAuthP7onCloseyxyycSgF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"onClose","kind":"identifier"},{"text":"((() -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")?) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"symbolKind":"method","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","title":"onClose(_:)","role":"symbol","required":true},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"onClose"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"callback","kind":"internalParam"},{"kind":"text","text":": (() -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")?) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"A callback to be executed"}],"type":"paragraph"}],"name":"callback"}]},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthUserAgent"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/onClose(_:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"onClose","kind":"identifier"},{"kind":"text","text":"((() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")?) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Specify a callback to be called when the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"type":"text","text":" closes, while the flow continues with the code exchange."}],"url":"\/documentation\/auth0\/webauth\/onclose(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","type":"topic","title":"onClose(_:)","required":true,"role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/organization(_:).json b/docs/data/documentation/auth0/webauth/organization(_:).json index f7d53f87..efd97a16 100644 --- a/docs/data/documentation/auth0/webauth/organization(_:).json +++ b/docs/data/documentation/auth0/webauth/organization(_:).json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth07WebAuthP12organizationyxSSF","required":true,"symbolKind":"method","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","title":"organization(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"organization"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"organization","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"organization","kind":"internalParam"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"organization","content":[{"inlineContent":[{"text":"ID of the organization.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/organization(_:)"]}],"abstract":[{"type":"text","text":"Specify an organization identifier to log in to."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/organization(_:)":{"abstract":[{"text":"Specify an organization identifier to log in to.","type":"text"}],"title":"organization(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","url":"\/documentation\/auth0\/webauth\/organization(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"organization","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/organization(_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Specify an organization identifier to log in to."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"organization"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"organization","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"ID of the organization."}],"type":"paragraph"}],"name":"organization"}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP12organizationyxSSF","symbolKind":"method","role":"symbol","title":"organization(_:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"organization"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"required":true},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/organization(_:)":{"abstract":[{"type":"text","text":"Specify an organization identifier to log in to."}],"required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"organization","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"url":"\/documentation\/auth0\/webauth\/organization(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","kind":"symbol","title":"organization(_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/parameters(_:).json b/docs/data/documentation/auth0/webauth/parameters(_:).json index c124ce61..58f696b2 100644 --- a/docs/data/documentation/auth0/webauth/parameters(_:).json +++ b/docs/data/documentation/auth0/webauth/parameters(_:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)"},"abstract":[{"type":"text","text":"Specify additional parameters for authentication."}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/parameters(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"parameters"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"parameters","kind":"internalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"]}]},{"parameters":[{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional authentication parameters."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"text":" instance to allow method chaining.","type":"text"}]}]}],"metadata":{"required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"parameters"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"externalID":"s:5Auth07WebAuthP10parametersyxSDyS2SGF","title":"parameters(_:)","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/parameters(_:)":{"required":true,"title":"parameters(_:)","role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webauth\/parameters(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","abstract":[{"type":"text","text":"Specify additional parameters for authentication."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/webauth\/parameters(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Specify additional parameters for authentication."}],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"parameters","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional authentication parameters."}]}],"name":"parameters"}]},{"content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","interfaceLanguage":"swift"},"metadata":{"title":"parameters(_:)","required":true,"externalID":"s:5Auth07WebAuthP10parametersyxSDyS2SGF","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"parameters","kind":"identifier"},{"kind":"text","text":"(["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"modules":[{"name":"Auth0"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/parameters(_:)":{"abstract":[{"text":"Specify additional parameters for authentication.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/parameters(_:)","title":"parameters(_:)","type":"topic","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/provider(_:).json b/docs/data/documentation/auth0/webauth/provider(_:).json index ffa4a9a4..0bff3700 100644 --- a/docs/data/documentation/auth0/webauth/provider(_:).json +++ b/docs/data/documentation/auth0/webauth/provider(_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"provider"},{"text":": ","kind":"text"},{"kind":"attribute","text":"@escaping"},{"text":" ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthProvider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"A custom Web Auth provider."}],"type":"paragraph"}],"name":"provider"}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]},{"content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"type":"aside","name":"Note","style":"note","content":[{"inlineContent":[{"type":"text","text":"Don’t use this method along with "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true,"type":"reference"},{"text":". Use either one or the other, because","type":"text"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},{"type":"text","text":" will only work with the default "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}],"type":"paragraph"}]}],"kind":"content"}],"abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/provider(_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","interfaceLanguage":"swift"},"metadata":{"title":"provider(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"externalID":"s:5Auth07WebAuthP8provideryxAA0bC9UserAgent_p10Foundation3URLV_ys6ResultOyytAA0bC5ErrorVGctcF","required":true,"roleHeading":"Instance Method","symbolKind":"method","role":"symbol","modules":[{"name":"Auth0"}]},"kind":"symbol","seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"],"title":"Related Documentation"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"provider","kind":"identifier"},{"kind":"text","text":"("},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"title":"provider(_:)","type":"topic","required":true,"url":"\/documentation\/auth0\/webauth\/provider(_:)","abstract":[{"type":"text","text":"Specify a custom Web Auth provider to use instead of the default "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"required":true,"kind":"symbol","abstract":[{"text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Using this method will disable single sign-on (SSO)."}],"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"useEphemeralSession","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"navigatorTitle":[{"text":"WebAuthProvider","kind":"identifier"}],"abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"text":" to perform a web-based operation.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"title":"WebAuthUserAgent","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"url":"\/documentation\/auth0\/useragents","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","role":"article","type":"topic"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/provider(_:)"]}],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"title":"provider(_:)","roleHeading":"Instance Method","symbolKind":"method","externalID":"s:5Auth07WebAuthP8provideryxAA0bC9UserAgent_p10Foundation3URLV_ys6ResultOyytAA0bC5ErrorVGctcF","modules":[{"name":"Auth0"}],"role":"symbol","required":true},"kind":"symbol","abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" implementation.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"provider"},{"text":": ","kind":"text"},{"kind":"attribute","text":"@escaping"},{"kind":"text","text":" "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"A custom Web Auth provider.","type":"text"}],"type":"paragraph"}],"name":"provider"}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"aside","name":"Note","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"Don’t use this method along with ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},{"text":". Use either one or the other, because","type":"text"},{"type":"text","text":" "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true},{"type":"text","text":" will only work with the default "},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" implementation."}]}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)"},"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"],"title":"Related Documentation"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"url":"\/documentation\/auth0\/useragents","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"role":"article","type":"topic","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthUserAgent"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"type":"text","text":" "},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","title":"provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"provider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","role":"symbol","type":"topic","kind":"symbol","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthProvider","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" to perform a web-based operation."},{"text":" ","type":"text"},{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" opens the URL in an external user agent and then invokes the callback when done."}],"role":"symbol","type":"topic","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/redirecturl(_:).json b/docs/data/documentation/auth0/webauth/redirecturl(_:).json index 3aa4e885..02305a3e 100644 --- a/docs/data/documentation/auth0/webauth/redirecturl(_:).json +++ b/docs/data/documentation/auth0/webauth/redirecturl(_:).json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"redirectURL"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"redirectURL"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Custom redirect URL.","type":"text"}],"type":"paragraph"}],"name":"redirectURL"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"metadata":{"required":true,"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"title":"redirectURL(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"redirectURL","kind":"identifier"},{"text":"(","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol","symbolKind":"method","externalID":"s:5Auth07WebAuthP11redirectURLyx10Foundation0E0VF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)"},"abstract":[{"type":"text","text":"Specify a custom redirect URL to be used."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/redirecturl(_:)"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/redirectURL(_:)":{"abstract":[{"text":"Specify a custom redirect URL to be used.","type":"text"}],"title":"redirectURL(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","url":"\/documentation\/auth0\/webauth\/redirecturl(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"redirectURL"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}]}}} \ No newline at end of file +{"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webauth\/redirecturl(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)"},"metadata":{"symbolKind":"method","title":"redirectURL(_:)","externalID":"s:5Auth07WebAuthP11redirectURLyx10Foundation0E0VF","role":"symbol","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"redirectURL"},{"kind":"text","text":"("},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Specify a custom redirect URL to be used."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"redirectURL"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"redirectURL","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Custom redirect URL.","type":"text"}]}],"name":"redirectURL"}]},{"content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/redirectURL(_:)":{"required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"redirectURL","kind":"identifier"},{"kind":"text","text":"("},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauth\/redirecturl(_:)","title":"redirectURL(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","abstract":[{"text":"Specify a custom redirect URL to be used.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/scope(_:).json b/docs/data/documentation/auth0/webauth/scope(_:).json index 41533203..cdc4622e 100644 --- a/docs/data/documentation/auth0/webauth/scope(_:).json +++ b/docs/data/documentation/auth0/webauth/scope(_:).json @@ -1 +1 @@ -{"abstract":[{"text":"Specify the scopes that will be requested during authentication.","type":"text"}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)"},"variants":[{"paths":["\/documentation\/auth0\/webauth\/scope(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"scope","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"text":"scope","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. For example,"},{"type":"text","text":" "},{"code":"openid profile email offline_access","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"scope"}]},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}],"kind":"content"}],"metadata":{"role":"symbol","externalID":"s:5Auth07WebAuthP5scopeyxSSF","symbolKind":"method","title":"scope(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","required":true},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/scope(_:)":{"role":"symbol","kind":"symbol","title":"scope(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","url":"\/documentation\/auth0\/webauth\/scope(_:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"text":"Specify the scopes that will be requested during authentication.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"https://auth0.com/docs/get-started/apis/scopes":{"titleInlineContent":[{"text":"Scopes","type":"text"}],"url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","title":"Scopes","type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"}}} \ No newline at end of file +{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"type":"text","text":"Specify the scopes that will be requested during authentication."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"metadata":{"symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","title":"scope(_:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"scope"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"externalID":"s:5Auth07WebAuthP5scopeyxSSF"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"scope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]}]},{"parameters":[{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of requested scope values. For example,","type":"text"},{"type":"text","text":" "},{"type":"codeVoice","code":"openid profile email offline_access"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/scope(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/scope(_:)":{"type":"topic","url":"\/documentation\/auth0\/webauth\/scope(_:)","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"scope"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"type":"text","text":"Specify the scopes that will be requested during authentication."}],"kind":"symbol","title":"scope(_:)"},"https://auth0.com/docs/get-started/apis/scopes":{"titleInlineContent":[{"type":"text","text":"Scopes"}],"url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","title":"Scopes"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/start()-98znq.json b/docs/data/documentation/auth0/webauth/start()-98znq.json index f29e4f3e..725eec45 100644 --- a/docs/data/documentation/auth0/webauth/start()-98znq.json +++ b/docs/data/documentation/auth0/webauth/start()-98znq.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"kind":"symbol","abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"kind":"text","text":"() "},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"inlineContent":[{"type":"text","text":"The result of the Web Auth flow."}],"type":"paragraph"}]},{"kind":"content","content":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"code":["do {"," let credentials = try await Auth0.webAuth().start()"," print(\"Obtained credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Any ongoing Web Auth transaction will be automatically cancelled when starting a new one,"},{"type":"text","text":" "},{"text":"and it will throw a ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"},{"type":"text","text":" error."}]},{"style":"note","content":[{"inlineContent":[{"text":"An error of type ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","type":"reference","isActive":true},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Throws","type":"aside"},{"content":[{"inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"text":"Callback URL","type":"text"}],"type":"strong"},{"text":" to have been added to the ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"Allowed Callback URLs"}]},{"type":"text","text":" field of your Auth0"},{"type":"text","text":" "},{"type":"text","text":"application settings in the "},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Requires","style":"note","type":"aside"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/start()-98znq"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthP5startAA11CredentialsCyYaKF","title":"start()","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"() ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"}],"required":true,"symbolKind":"method"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"https://manage.auth0.com/#/applications/":{"url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard","type":"link","titleInlineContent":[{"type":"text","text":"Dashboard"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"kind":"symbol","title":"userCancelled","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","type":"topic","url":"\/documentation\/auth0\/webautherror\/usercancelled","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"abstract":[{"type":"text","text":"The user cancelled the Web Auth operation."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-98znq":{"role":"symbol","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","url":"\/documentation\/auth0\/webauth\/start()-98znq","title":"start()","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}],"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}]}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The result of the Web Auth flow."}]}]},{"content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["do {"," let credentials = try await Auth0.webAuth().start()"," print(\"Obtained credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"syntax":"swift"},{"inlineContent":[{"type":"text","text":"Any ongoing Web Auth transaction will be automatically cancelled when starting a new one,"},{"type":"text","text":" "},{"text":"and it will throw a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","type":"reference","isActive":true},{"type":"text","text":" error."}],"type":"paragraph"},{"style":"note","name":"Throws","type":"aside","content":[{"inlineContent":[{"type":"text","text":"An error of type "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","type":"reference","isActive":true},{"type":"text","text":"."}],"type":"paragraph"}]},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"strong","inlineContent":[{"type":"text","text":"Callback URL"}]},{"type":"text","text":" to have been added to the "},{"type":"strong","inlineContent":[{"type":"text","text":"Allowed Callback URLs"}]},{"type":"text","text":" field of your Auth0"},{"text":" ","type":"text"},{"text":"application settings in the ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Requires"}],"kind":"content"}],"kind":"symbol","sections":[],"metadata":{"symbolKind":"method","title":"start()","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","required":true,"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"}],"externalID":"s:5Auth07WebAuthP5startAA11CredentialsCyYaKF","role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"variants":[{"paths":["\/documentation\/auth0\/webauth\/start()-98znq"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-98znq":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","kind":"symbol","required":true,"title":"start()","type":"topic","url":"\/documentation\/auth0\/webauth\/start()-98znq","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"}],"abstract":[{"type":"text","text":"Starts the Web Auth flow."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"url":"\/documentation\/auth0\/webautherror\/usercancelled","title":"userCancelled","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","abstract":[{"text":"The user cancelled the Web Auth operation.","type":"text"},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"},"https://manage.auth0.com/#/applications/":{"titleInlineContent":[{"type":"text","text":"Dashboard"}],"title":"Dashboard","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","url":"https:\/\/manage.auth0.com\/#\/applications\/"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/start()-qpqo.json b/docs/data/documentation/auth0/webauth/start()-qpqo.json index 748df022..3bd64ae9 100644 --- a/docs/data/documentation/auth0/webauth/start()-qpqo.json +++ b/docs/data/documentation/auth0/webauth/start()-qpqo.json @@ -1 +1 @@ -{"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A type-erased publisher."}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"type":"codeListing","code":["Auth0"," .webAuth()"," .start()"," .sink(receiveCompletion: { completion in"," if case .failure(let error) = completion {"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: { credentials in"," print(\"Obtained credentials: \\(credentials)\")"," })"," .store(in: &cancellables)"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Any ongoing Web Auth transaction will be automatically cancelled when starting a new one,"},{"type":"text","text":" "},{"text":"and the subscription will complete with a result containing a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","type":"reference","isActive":true},{"text":" error.","type":"text"}]},{"name":"Requires","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"type":"text","text":" to have been added to the "},{"inlineContent":[{"type":"text","text":"Allowed Callback URLs"}],"type":"strong"},{"type":"text","text":" field of your Auth0"},{"type":"text","text":" "},{"type":"text","text":"application settings in the "},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference"},{"text":".","type":"text"}]}],"style":"note"}],"kind":"content"}],"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Method","title":"start()","externalID":"s:5Auth07WebAuthP5start7Combine12AnyPublisherVyAA11CredentialsCAA0bC5ErrorVGyF","modules":[{"name":"Auth0"}],"symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","required":true},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"variants":[{"paths":["\/documentation\/auth0\/webauth\/start()-qpqo"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-qpqo":{"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"title":"start()","kind":"symbol","role":"symbol","type":"topic","required":true,"url":"\/documentation\/auth0\/webauth\/start()-qpqo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"kind":"symbol","title":"userCancelled","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","type":"topic","url":"\/documentation\/auth0\/webautherror\/usercancelled","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"abstract":[{"type":"text","text":"The user cancelled the Web Auth operation."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"role":"symbol"},"https://manage.auth0.com/#/applications/":{"url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"type":"text","text":"Dashboard"}],"type":"link","title":"Dashboard"}}} \ No newline at end of file +{"sections":[],"metadata":{"externalID":"s:5Auth07WebAuthP5start7Combine12AnyPublisherVyAA11CredentialsCAA0bC5ErrorVGyF","roleHeading":"Instance Method","required":true,"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"start()","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/start()-qpqo"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo"},"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A type-erased publisher."}]}],"kind":"content"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","code":["Auth0"," .webAuth()"," .start()"," .sink(receiveCompletion: { completion in"," if case .failure(let error) = completion {"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: { credentials in"," print(\"Obtained credentials: \\(credentials)\")"," })"," .store(in: &cancellables)"],"syntax":"swift"},{"inlineContent":[{"type":"text","text":"Any ongoing Web Auth transaction will be automatically cancelled when starting a new one,"},{"text":" ","type":"text"},{"text":"and the subscription will complete with a result containing a ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"},{"type":"text","text":" error."}],"type":"paragraph"},{"type":"aside","name":"Requires","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"strong","inlineContent":[{"text":"Callback URL","type":"text"}]},{"text":" to have been added to the ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"Allowed Callback URLs"}]},{"type":"text","text":" field of your Auth0"},{"type":"text","text":" "},{"text":"application settings in the ","type":"text"},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true},{"text":".","type":"text"}]}]}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-qpqo":{"url":"\/documentation\/auth0\/webauth\/start()-qpqo","required":true,"title":"start()","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"type":"topic","abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"https://manage.auth0.com/#/applications/":{"title":"Dashboard","url":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","titleInlineContent":[{"text":"Dashboard","type":"text"}],"identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"url":"\/documentation\/auth0\/webautherror\/usercancelled","title":"userCancelled","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","abstract":[{"text":"The user cancelled the Web Auth operation.","type":"text"},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/start(_:).json b/docs/data/documentation/auth0/webauth/start(_:).json index 90deeb19..c41f45ad 100644 --- a/docs/data/documentation/auth0/webauth/start(_:).json +++ b/docs/data/documentation/auth0/webauth/start(_:).json @@ -1 +1 @@ -{"metadata":{"required":true,"title":"start(_:)","role":"symbol","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"((","kind":"text"},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}],"externalID":"s:5Auth07WebAuthP5startyyys6ResultOyAA11CredentialsCAA0bC5ErrorVGcF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"callback"},{"kind":"text","text":": "},{"kind":"attribute","text":"@escaping"},{"text":" (","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"text":")","kind":"text"}],"languages":["swift"]}]},{"parameters":[{"name":"callback","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Callback that receives a "},{"code":"Result","type":"codeVoice"},{"text":" containing either the user’s credentials or an error.","type":"text"}]}]}],"kind":"parameters"},{"content":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"code":["Auth0"," .webAuth()"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"syntax":"swift","type":"codeListing"},{"type":"paragraph","inlineContent":[{"text":"Any ongoing Web Auth transaction will be automatically cancelled when starting a new one,","type":"text"},{"text":" ","type":"text"},{"text":"and its corresponding callback with be called with a result containing a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","isActive":true},{"type":"text","text":" error."}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"text":" to have been added to the ","type":"text"},{"inlineContent":[{"text":"Allowed Callback URLs","type":"text"}],"type":"strong"},{"text":" field of your Auth0","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"application settings in the "},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference","isActive":true},{"text":".","type":"text"}]}],"style":"note","type":"aside","name":"Requires"}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/start(_:)"]}],"abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"url":"\/documentation\/auth0\/webauthresult","role":"symbol","title":"WebAuthResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthResult"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"url":"\/documentation\/auth0\/credentials","kind":"symbol","abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"role":"symbol","title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"kind":"symbol","title":"userCancelled","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","type":"topic","url":"\/documentation\/auth0\/webautherror\/usercancelled","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"abstract":[{"type":"text","text":"The user cancelled the Web Auth operation."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start(_:)":{"url":"\/documentation\/auth0\/webauth\/start(_:)","title":"start(_:)","kind":"symbol","abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"kind":"text","text":"(("},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"type":"topic"},"https://manage.auth0.com/#/applications/":{"url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","title":"Dashboard","titleInlineContent":[{"type":"text","text":"Dashboard"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)"},"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/webauth\/start(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"text":"WebAuthResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Callback that receives a "},{"type":"codeVoice","code":"Result"},{"type":"text","text":" containing either the user’s credentials or an error."}],"type":"paragraph"}],"name":"callback"}],"kind":"parameters"},{"content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["Auth0"," .webAuth()"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"syntax":"swift"},{"inlineContent":[{"type":"text","text":"Any ongoing Web Auth transaction will be automatically cancelled when starting a new one,"},{"text":" ","type":"text"},{"type":"text","text":"and its corresponding callback with be called with a result containing a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","isActive":true},{"type":"text","text":" error."}],"type":"paragraph"},{"name":"Requires","style":"note","content":[{"inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"type":"text","text":" to have been added to the "},{"inlineContent":[{"type":"text","text":"Allowed Callback URLs"}],"type":"strong"},{"type":"text","text":" field of your Auth0"},{"type":"text","text":" "},{"type":"text","text":"application settings in the "},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference","isActive":true},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside"}],"kind":"content"}],"kind":"symbol","metadata":{"required":true,"role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP5startyyys6ResultOyAA11CredentialsCAA0bC5ErrorVGcF","symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"((","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"title":"start(_:)"},"references":{"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard","type":"link","titleInlineContent":[{"text":"Dashboard","type":"text"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"title":"Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"Credentials","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"topic","url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start(_:)":{"abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"required":true,"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"((","kind":"text"},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"kind":"text","text":")"}],"title":"start(_:)","kind":"symbol","url":"\/documentation\/auth0\/webauth\/start(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"url":"\/documentation\/auth0\/webautherror\/usercancelled","title":"userCancelled","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","abstract":[{"text":"The user cancelled the Web Auth operation.","type":"text"},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/state(_:).json b/docs/data/documentation/auth0/webauth/state(_:).json index 09599009..179dfdea 100644 --- a/docs/data/documentation/auth0/webauth/state(_:).json +++ b/docs/data/documentation/auth0/webauth/state(_:).json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)"},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","metadata":{"symbolKind":"method","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"state"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthP5stateyxSSF","title":"state(_:)","roleHeading":"Instance Method"},"abstract":[{"type":"text","text":"Specify a "},{"type":"codeVoice","code":"state"},{"text":" parameter that will be sent back after authentication to verify that the response","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"corresponds to your request."},{"type":"text","text":" "},{"type":"text","text":"By default a random value is used."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"state"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"state","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"state","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"State value."}]}]}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/state(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/state(_:)":{"abstract":[{"text":"Specify a ","type":"text"},{"code":"state","type":"codeVoice"},{"text":" parameter that will be sent back after authentication to verify that the response","type":"text"},{"text":" ","type":"text"},{"text":"corresponds to your request.","type":"text"},{"type":"text","text":" "},{"text":"By default a random value is used.","type":"text"}],"title":"state(_:)","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","url":"\/documentation\/auth0\/webauth\/state(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"state","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"text":"Specify a ","type":"text"},{"code":"state","type":"codeVoice"},{"text":" parameter that will be sent back after authentication to verify that the response","type":"text"},{"text":" ","type":"text"},{"text":"corresponds to your request.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"By default a random value is used."}],"sections":[],"metadata":{"role":"symbol","externalID":"s:5Auth07WebAuthP5stateyxSSF","required":true,"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"title":"state(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"state","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"symbolKind":"method"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"state"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"state","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"State value."}]}],"name":"state"}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/state(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/state(_:)":{"type":"topic","url":"\/documentation\/auth0\/webauth\/state(_:)","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"state"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"type":"text","text":"Specify a "},{"type":"codeVoice","code":"state"},{"text":" parameter that will be sent back after authentication to verify that the response","type":"text"},{"text":" ","type":"text"},{"text":"corresponds to your request.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"By default a random value is used."}],"kind":"symbol","title":"state(_:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/telemetry.json b/docs/data/documentation/auth0/webauth/telemetry.json index 97413a8e..b76f4adf 100644 --- a/docs/data/documentation/auth0/webauth/telemetry.json +++ b/docs/data/documentation/auth0/webauth/telemetry.json @@ -1 +1 @@ -{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"abstract":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},{"text":" instance.","type":"text"}],"metadata":{"externalID":"s:5Auth07WebAuthP9telemetryAA9TelemetryVvp","role":"symbol","symbolKind":"property","roleHeading":"Instance Property","title":"telemetry","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry"}],"required":true,"modules":[{"name":"Auth0"}]},"variants":[{"paths":["\/documentation\/auth0\/webauth\/telemetry"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" ","kind":"text"},{"kind":"keyword","text":"set"},{"kind":"text","text":" }"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Telemetry"}],"navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"url":"\/documentation\/auth0\/telemetry","title":"Telemetry","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/telemetry":{"abstract":[{"type":"text","text":"The "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"reference"},{"text":" instance.","type":"text"}],"title":"telemetry","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","url":"\/documentation\/auth0\/webauth\/telemetry","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true},{"type":"text","text":" instance."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"title":"telemetry","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier","text":"Telemetry"}],"role":"symbol","externalID":"s:5Auth07WebAuthP9telemetryAA9TelemetryVvp","symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","required":true},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/telemetry"]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","interfaceLanguage":"swift"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" "},{"text":"set","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/telemetry":{"required":true,"abstract":[{"text":"The ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true},{"type":"text","text":" instance."}],"title":"telemetry","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","url":"\/documentation\/auth0\/webauth\/telemetry","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","title":"Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"kind":"symbol","url":"\/documentation\/auth0\/telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/url.json b/docs/data/documentation/auth0/webauth/url.json index 53143ccf..fa9602c8 100644 --- a/docs/data/documentation/auth0/webauth/url.json +++ b/docs/data/documentation/auth0/webauth/url.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url"},"variants":[{"paths":["\/documentation\/auth0\/webauth\/url"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"url","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}],"title":"url","modules":[{"name":"Auth0"}],"required":true,"role":"symbol","symbolKind":"property","externalID":"s:5Auth07WebAuthP3url10Foundation3URLVvp"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/url":{"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"title":"url","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","url":"\/documentation\/auth0\/webauth\/url","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"}]}}} \ No newline at end of file +{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/url"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth07WebAuthP3url10Foundation3URLVvp","title":"url","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"roleHeading":"Instance Property","required":true,"role":"symbol","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/url":{"kind":"symbol","title":"url","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"type":"topic","abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"required":true,"role":"symbol","url":"\/documentation\/auth0\/webauth\/url"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/useephemeralsession().json b/docs/data/documentation/auth0/webauth/useephemeralsession().json index af934a42..85b08b84 100644 --- a/docs/data/documentation/auth0/webauth/useephemeralsession().json +++ b/docs/data/documentation/auth0/webauth/useephemeralsession().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"useEphemeralSession","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"style":"important","type":"aside","name":"Important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","type":"reference"},{"type":"text","text":" if you are using this"},{"text":" ","type":"text"},{"type":"text","text":"method on login, because there will be no shared cookie to remove."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Don’t use this method along with "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)"},{"text":". Use either one or the other, because this","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"method will only work with the default "},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" implementation."}]}],"style":"note","type":"aside","name":"Note"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio"],"title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/useephemeralsession()"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"title":"useEphemeralSession()","externalID":"s:5Auth07WebAuthP19useEphemeralSessionxyF"},"sections":[],"abstract":[{"text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar.","type":"text"},{"text":" ","type":"text"},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"provider","kind":"identifier"},{"kind":"text","text":"("},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"title":"provider(_:)","type":"topic","required":true,"url":"\/documentation\/auth0\/webauth\/provider(_:)","abstract":[{"type":"text","text":"Specify a custom Web Auth provider to use instead of the default "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"url":"\/documentation\/auth0\/useragents","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","role":"article","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"kind":"symbol","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"text":": (","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","title":"clearSession(federated:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","type":"topic","role":"symbol"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession/3237231-prefersephemeralwebbrowsersessio":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","type":"link","title":"prefersEphemeralWebBrowserSession","titleInlineContent":[{"type":"text","text":"prefersEphemeralWebBrowserSession"}]},"https://github.com/auth0/Auth0.swift/blob/master/FAQ.md":{"url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","titleInlineContent":[{"type":"text","text":"FAQ"}],"title":"FAQ","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"required":true,"kind":"symbol","abstract":[{"text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Using this method will disable single sign-on (SSO)."}],"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"useEphemeralSession","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/useephemeralsession()"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"metadata":{"role":"symbol","title":"useEphemeralSession()","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"text":"Self","kind":"typeIdentifier"}],"symbolKind":"method","required":true,"modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthP19useEphemeralSessionxyF"},"abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"text":" ","type":"text"},{"type":"text","text":"Using this method will disable single sign-on (SSO)."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"useEphemeralSession","kind":"identifier"},{"kind":"text","text":"() -> "},{"text":"Self","kind":"typeIdentifier"}]}]},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"},{"content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"style":"important","type":"aside","name":"Important","content":[{"inlineContent":[{"type":"text","text":"You don’t need to call "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","isActive":true,"type":"reference"},{"type":"text","text":" if you are using this"},{"text":" ","type":"text"},{"text":"method on login, because there will be no shared cookie to remove.","type":"text"}],"type":"paragraph"}]},{"name":"Note","type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"Don’t use this method along with "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","type":"reference"},{"text":". Use either one or the other, because this","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"method will only work with the default "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}],"type":"paragraph"}]}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"title":"clearSession(federated:callback:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"title":"useEphemeralSession()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","abstract":[{"type":"text","text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar."},{"type":"text","text":" "},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession/3237231-prefersephemeralwebbrowsersessio":{"title":"prefersEphemeralWebBrowserSession","type":"link","titleInlineContent":[{"text":"prefersEphemeralWebBrowserSession","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","title":"provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"provider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","role":"symbol","type":"topic","kind":"symbol","required":true},"https://github.com/auth0/Auth0.swift/blob/master/FAQ.md":{"titleInlineContent":[{"type":"text","text":"FAQ"}],"type":"link","url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","title":"FAQ","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"url":"\/documentation\/auth0\/useragents","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"role":"article","type":"topic","kind":"article"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/usehttps().json b/docs/data/documentation/auth0/webauth/usehttps().json index 71efd5bc..090406d7 100644 --- a/docs/data/documentation/auth0/webauth/usehttps().json +++ b/docs/data/documentation/auth0/webauth/usehttps().json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/webauth\/usehttps()"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useHTTPS"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]},{"content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"content":[{"inlineContent":[{"text":"An Associated Domain configured with the ","type":"text"},{"code":"webcredentials","type":"codeVoice"},{"text":" service type. For example,","type":"text"},{"type":"text","text":" "},{"type":"codeVoice","code":"webcredentials:example.com"},{"type":"text","text":". If you’re using a custom domain on your Auth0 tenant, use this domain as the"},{"type":"text","text":" "},{"type":"text","text":"Associated Domain. Otherwise, use the domain of your Auth0 tenant."}],"type":"paragraph"}],"style":"note","name":"Requires","type":"aside"},{"name":"Note","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Don’t use this method along with "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)"},{"type":"text","text":". Use either one or the other, because this"},{"text":" ","type":"text"},{"text":"method will only work with the default ","type":"text"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" implementation."}]}],"type":"aside"}],"kind":"content"}],"kind":"symbol","abstract":[{"type":"text","text":"Use "},{"type":"codeVoice","code":"https"},{"text":" as the scheme for the redirect URL on iOS 17.4+ and macOS 14.4+. On older versions of iOS and","type":"text"},{"type":"text","text":" "},{"type":"text","text":"macOS, the bundle identifier of the app will be used as a custom scheme."}],"sections":[],"metadata":{"required":true,"externalID":"s:5Auth07WebAuthP8useHTTPSxyF","title":"useHTTPS()","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"useHTTPS","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"symbolKind":"method"},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useHTTPS()":{"abstract":[{"text":"Use ","type":"text"},{"code":"https","type":"codeVoice"},{"text":" as the scheme for the redirect URL on iOS 17.4+ and macOS 14.4+. On older versions of iOS and","type":"text"},{"text":" ","type":"text"},{"text":"macOS, the bundle identifier of the app will be used as a custom scheme.","type":"text"}],"title":"useHTTPS()","kind":"symbol","role":"symbol","type":"topic","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","url":"\/documentation\/auth0\/webauth\/usehttps()","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"useHTTPS","kind":"identifier"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"url":"\/documentation\/auth0\/webauth","title":"WebAuth","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"provider","kind":"identifier"},{"kind":"text","text":"("},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"title":"provider(_:)","type":"topic","required":true,"url":"\/documentation\/auth0\/webauth\/provider(_:)","abstract":[{"type":"text","text":"Specify a custom Web Auth provider to use instead of the default "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}]}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"abstract":[{"text":"Use ","type":"text"},{"code":"https","type":"codeVoice"},{"type":"text","text":" as the scheme for the redirect URL on iOS 17.4+ and macOS 14.4+. On older versions of iOS and"},{"text":" ","type":"text"},{"type":"text","text":"macOS, the bundle identifier of the app will be used as a custom scheme."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"useHTTPS","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"style":"note","content":[{"inlineContent":[{"text":"An Associated Domain configured with the ","type":"text"},{"code":"webcredentials","type":"codeVoice"},{"type":"text","text":" service type. For example,"},{"type":"text","text":" "},{"code":"webcredentials:example.com","type":"codeVoice"},{"text":". If you’re using a custom domain on your Auth0 tenant, use this domain as the","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Associated Domain. Otherwise, use the domain of your Auth0 tenant."}],"type":"paragraph"}],"type":"aside","name":"Requires"},{"name":"Note","style":"note","content":[{"inlineContent":[{"type":"text","text":"Don’t use this method along with "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","type":"reference","isActive":true},{"type":"text","text":". Use either one or the other, because this"},{"type":"text","text":" "},{"type":"text","text":"method will only work with the default "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}],"type":"paragraph"}],"type":"aside"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/usehttps()"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"useHTTPS"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"roleHeading":"Instance Method","title":"useHTTPS()","modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthP8useHTTPSxyF","symbolKind":"method","role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"title":"WebAuth","url":"\/documentation\/auth0\/webauth","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"}],"abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useHTTPS()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","title":"useHTTPS()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"useHTTPS","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Use "},{"type":"codeVoice","code":"https"},{"text":" as the scheme for the redirect URL on iOS 17.4+ and macOS 14.4+. On older versions of iOS and","type":"text"},{"type":"text","text":" "},{"text":"macOS, the bundle identifier of the app will be used as a custom scheme.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/usehttps()","role":"symbol","type":"topic","kind":"symbol","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","title":"provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"provider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","role":"symbol","type":"topic","kind":"symbol","required":true},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthentication.json b/docs/data/documentation/auth0/webauthentication.json index fe062382..f5965c4e 100644 --- a/docs/data/documentation/auth0/webauthentication.json +++ b/docs/data/documentation/auth0/webauthentication.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"platforms":["iOS"],"languages":["swift"]}]}],"topicSections":[{"title":"Type Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)"]}],"abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webauthentication"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"title":"WebAuthentication","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthentication"}],"externalID":"s:5Auth017WebAuthenticationV","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Structure","symbolKind":"struct"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"provider","kind":"identifier"},{"kind":"text","text":"("},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"title":"provider(_:)","type":"topic","required":true,"url":"\/documentation\/auth0\/webauth\/provider(_:)","abstract":[{"type":"text","text":"Specify a custom Web Auth provider to use instead of the default "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"title":"WebAuthUserAgent","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/safariProvider(style:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"safariProvider","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider"}],"title":"safariProvider(style:)","type":"topic","url":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)","abstract":[{"type":"text","text":"Creates a Web Auth provider that uses "},{"code":"SFSafariViewController","type":"codeVoice"},{"text":" as the external user agent.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/cancel()":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"cancel","kind":"identifier"},{"kind":"text","text":"()"}],"title":"cancel()","type":"topic","url":"\/documentation\/auth0\/webauthentication\/cancel()","abstract":[{"text":"Terminates the ongoing web-based operation and reports back that it was cancelled.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"You need to call this method within your custom Web Auth provider implementation whenever the operation is"},{"type":"text","text":" "},{"text":"cancelled by the user.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/resume(with:)":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","abstract":[{"type":"text","text":"Resumes the web-based operation when the external user agent redirects back to the app using a URL with a"},{"type":"text","text":" "},{"text":"custom scheme.","type":"text"}],"url":"\/documentation\/auth0\/webauthentication\/resume(with:)","kind":"symbol","title":"resume(with:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resume","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthentication"}],"navigatorTitle":[{"text":"WebAuthentication","kind":"identifier"}],"abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"url":"\/documentation\/auth0\/webauthentication","title":"WebAuthentication","role":"symbol","type":"topic"}}} \ No newline at end of file +{"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"},"abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"metadata":{"title":"WebAuthentication","roleHeading":"Structure","symbolKind":"struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth017WebAuthenticationV","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)"],"title":"Type Methods"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"WebAuthentication","kind":"identifier"}],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthentication","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthentication","role":"symbol","title":"WebAuthentication","abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/safariProvider(style:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)","type":"topic","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"safariProvider"},{"kind":"text","text":"("},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"text":"UIModalPresentationStyle","preciseIdentifier":"c:@E@UIModalPresentationStyle","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier"}],"title":"safariProvider(style:)","abstract":[{"type":"text","text":"Creates a Web Auth provider that uses "},{"type":"codeVoice","code":"SFSafariViewController"},{"text":" as the external user agent.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/cancel()":{"abstract":[{"text":"Terminates the ongoing web-based operation and reports back that it was cancelled.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"You need to call this method within your custom Web Auth provider implementation whenever the operation is"},{"type":"text","text":" "},{"type":"text","text":"cancelled by the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cancel","kind":"identifier"},{"kind":"text","text":"()"}],"url":"\/documentation\/auth0\/webauthentication\/cancel()","role":"symbol","title":"cancel()","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/resume(with:)":{"title":"resume(with:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"resume","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauthentication\/resume(with:)","abstract":[{"text":"Resumes the web-based operation when the external user agent redirects back to the app using a URL with a","type":"text"},{"type":"text","text":" "},{"type":"text","text":"custom scheme."}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","title":"provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"provider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","role":"symbol","type":"topic","kind":"symbol","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthUserAgent"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthentication/cancel().json b/docs/data/documentation/auth0/webauthentication/cancel().json index 63a12712..578c6196 100644 --- a/docs/data/documentation/auth0/webauthentication/cancel().json +++ b/docs/data/documentation/auth0/webauthentication/cancel().json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Terminates the ongoing web-based operation and reports back that it was cancelled."},{"type":"text","text":" "},{"type":"text","text":"You need to call this method within your custom Web Auth provider implementation whenever the operation is"},{"type":"text","text":" "},{"type":"text","text":"cancelled by the user."}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"metadata":{"externalID":"s:5Auth017WebAuthenticationV6cancelyyFZ","role":"symbol","modules":[{"name":"Auth0"}],"title":"cancel()","symbolKind":"method","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cancel"},{"text":"()","kind":"text"}],"roleHeading":"Type Method"},"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"cancel","kind":"identifier"},{"text":"()","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/cancel()"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/cancel()":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"cancel","kind":"identifier"},{"kind":"text","text":"()"}],"title":"cancel()","type":"topic","url":"\/documentation\/auth0\/webauthentication\/cancel()","abstract":[{"text":"Terminates the ongoing web-based operation and reports back that it was cancelled.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"You need to call this method within your custom Web Auth provider implementation whenever the operation is"},{"type":"text","text":" "},{"text":"cancelled by the user.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthentication"}],"navigatorTitle":[{"text":"WebAuthentication","kind":"identifier"}],"abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"url":"\/documentation\/auth0\/webauthentication","title":"WebAuthentication","role":"symbol","type":"topic"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"abstract":[{"type":"text","text":"Terminates the ongoing web-based operation and reports back that it was cancelled."},{"type":"text","text":" "},{"text":"You need to call this method within your custom Web Auth provider implementation whenever the operation is","type":"text"},{"type":"text","text":" "},{"text":"cancelled by the user.","type":"text"}],"metadata":{"symbolKind":"method","title":"cancel()","modules":[{"name":"Auth0"}],"roleHeading":"Type Method","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cancel"},{"text":"()","kind":"text"}],"externalID":"s:5Auth017WebAuthenticationV6cancelyyFZ","role":"symbol"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/cancel()"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"cancel","kind":"identifier"},{"kind":"text","text":"()"}],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/cancel()":{"abstract":[{"text":"Terminates the ongoing web-based operation and reports back that it was cancelled.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"You need to call this method within your custom Web Auth provider implementation whenever the operation is"},{"type":"text","text":" "},{"type":"text","text":"cancelled by the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cancel","kind":"identifier"},{"kind":"text","text":"()"}],"url":"\/documentation\/auth0\/webauthentication\/cancel()","role":"symbol","title":"cancel()","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthentication","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthentication","role":"symbol","title":"WebAuthentication","abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthentication/resume(with:).json b/docs/data/documentation/auth0/webauthentication/resume(with:).json index 8b159645..401e6b6f 100644 --- a/docs/data/documentation/auth0/webauthentication/resume(with:).json +++ b/docs/data/documentation/auth0/webauthentication/resume(with:).json @@ -1 +1 @@ -{"abstract":[{"text":"Resumes the web-based operation when the external user agent redirects back to the app using a URL with a","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"custom scheme."}],"sections":[],"metadata":{"symbolKind":"method","role":"symbol","roleHeading":"Type Method","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"resume"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth017WebAuthenticationV6resume4withSb10Foundation3URLV_tFZ","title":"resume(with:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/resume(with:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"@discardableResult","kind":"attribute"},{"kind":"text","text":" "},{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"resume","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"text":" ","kind":"text"},{"text":"url","kind":"internalParam"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"url","content":[{"inlineContent":[{"text":"The URL sent by the external user agent that contains the result of the web-based operation.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"If the URL was expected and properly formatted.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"type":"heading","level":3,"text":"For UIKit app lifecycle","anchor":"For-UIKit-app-lifecycle"},{"type":"paragraph","inlineContent":[{"text":"In your ","type":"text"},{"type":"codeVoice","code":"AppDelegate.swift"},{"text":":","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["func application(_ app: UIApplication,"," open url: URL,"," options: [UIApplication.OpenURLOptionsKey: Any]) -> Bool {"," return WebAuthentication.resume(with: url)","}"]},{"text":"For UIKit app lifecycle with Scenes","type":"heading","anchor":"For-UIKit-app-lifecycle-with-Scenes","level":3},{"type":"paragraph","inlineContent":[{"text":"In your ","type":"text"},{"type":"codeVoice","code":"SceneDelegate.swift"},{"type":"text","text":":"}]},{"syntax":"swift","code":["func scene(_ scene: UIScene, openURLContexts URLContexts: Set) {"," guard let url = URLContexts.first?.url else { return }"," WebAuthentication.resume(with: url)","}"],"type":"codeListing"},{"anchor":"For-SwiftUI-app-lifecycle","text":"For SwiftUI app lifecycle","level":3,"type":"heading"},{"syntax":"swift","code":["SomeView()"," .onOpenURL { url in"," WebAuthentication.resume(with: url)"," }"],"type":"codeListing"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/resume(with:)":{"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","abstract":[{"type":"text","text":"Resumes the web-based operation when the external user agent redirects back to the app using a URL with a"},{"type":"text","text":" "},{"text":"custom scheme.","type":"text"}],"url":"\/documentation\/auth0\/webauthentication\/resume(with:)","kind":"symbol","title":"resume(with:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resume","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthentication"}],"navigatorTitle":[{"text":"WebAuthentication","kind":"identifier"}],"abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"url":"\/documentation\/auth0\/webauthentication","title":"WebAuthentication","role":"symbol","type":"topic"}}} \ No newline at end of file +{"sections":[],"abstract":[{"type":"text","text":"Resumes the web-based operation when the external user agent redirects back to the app using a URL with a"},{"type":"text","text":" "},{"type":"text","text":"custom scheme."}],"metadata":{"symbolKind":"method","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"resume"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"resume(with:)","externalID":"s:5Auth017WebAuthenticationV6resume4withSb10Foundation3URLV_tFZ","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Type Method"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"@discardableResult","kind":"attribute"},{"text":" ","kind":"text"},{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"resume","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"with"},{"text":" ","kind":"text"},{"text":"url","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"url","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The URL sent by the external user agent that contains the result of the web-based operation."}]}]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"If the URL was expected and properly formatted.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"anchor":"For-UIKit-app-lifecycle","text":"For UIKit app lifecycle","type":"heading","level":3},{"type":"paragraph","inlineContent":[{"type":"text","text":"In your "},{"type":"codeVoice","code":"AppDelegate.swift"},{"type":"text","text":":"}]},{"code":["func application(_ app: UIApplication,"," open url: URL,"," options: [UIApplication.OpenURLOptionsKey: Any]) -> Bool {"," return WebAuthentication.resume(with: url)","}"],"syntax":"swift","type":"codeListing"},{"text":"For UIKit app lifecycle with Scenes","type":"heading","anchor":"For-UIKit-app-lifecycle-with-Scenes","level":3},{"type":"paragraph","inlineContent":[{"text":"In your ","type":"text"},{"code":"SceneDelegate.swift","type":"codeVoice"},{"type":"text","text":":"}]},{"code":["func scene(_ scene: UIScene, openURLContexts URLContexts: Set) {"," guard let url = URLContexts.first?.url else { return }"," WebAuthentication.resume(with: url)","}"],"type":"codeListing","syntax":"swift"},{"level":3,"text":"For SwiftUI app lifecycle","anchor":"For-SwiftUI-app-lifecycle","type":"heading"},{"type":"codeListing","code":["SomeView()"," .onOpenURL { url in"," WebAuthentication.resume(with: url)"," }"],"syntax":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/resume(with:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)"},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthentication","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthentication","role":"symbol","title":"WebAuthentication","abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/resume(with:)":{"title":"resume(with:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"resume","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauthentication\/resume(with:)","abstract":[{"text":"Resumes the web-based operation when the external user agent redirects back to the app using a URL with a","type":"text"},{"type":"text","text":" "},{"type":"text","text":"custom scheme."}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthentication/safariprovider(style:).json b/docs/data/documentation/auth0/webauthentication/safariprovider(style:).json index a4386340..f27b6dd5 100644 --- a/docs/data/documentation/auth0/webauthentication/safariprovider(style:).json +++ b/docs/data/documentation/auth0/webauthentication/safariprovider(style:).json @@ -1 +1 @@ -{"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"safariProvider","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle"},{"text":" = .fullScreen) -> ","kind":"text"},{"text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":"UIModalPresentationStyle"},{"type":"text","text":" to be used. Defaults to "},{"code":".fullScreen","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"style"}]},{"content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"A ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"},{"type":"text","text":" instance."}]}],"kind":"content"},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"syntax":"swift","code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider())"," .start { result in"," \/\/ ...","}"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"If you need to specify a custom "},{"code":"UIModalPresentationStyle","type":"codeVoice"},{"type":"text","text":":"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider(style: .formSheet))"," .start { result in"," \/\/ ...","}"],"type":"codeListing"}]}],"variants":[{"paths":["\/documentation\/auth0\/webauthentication\/safariprovider(style:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"title":"safariProvider(style:)","externalID":"s:5Auth017WebAuthenticationV14safariProvider5styleAA0B13AuthUserAgent_p10Foundation3URLV_ys6ResultOyytAA0bG5ErrorVGctcSo24UIModalPresentationStyleV_tFZ","symbolKind":"method","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"safariProvider","kind":"identifier"},{"kind":"text","text":"("},{"text":"style","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier","text":"WebAuthProvider"}],"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Type Method","extendedModule":"Auth0"},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"Creates a Web Auth provider that uses ","type":"text"},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" as the external user agent."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"url":"\/documentation\/auth0\/useragents","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","role":"article","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/safariProvider(style:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"safariProvider","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider"}],"title":"safariProvider(style:)","type":"topic","url":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)","abstract":[{"type":"text","text":"Creates a Web Auth provider that uses "},{"code":"SFSafariViewController","type":"codeVoice"},{"text":" as the external user agent.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"title":"WebAuthUserAgent","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"navigatorTitle":[{"text":"WebAuthProvider","kind":"identifier"}],"abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"text":" to perform a web-based operation.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthentication"}],"navigatorTitle":[{"text":"WebAuthentication","kind":"identifier"}],"abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"url":"\/documentation\/auth0\/webauthentication","title":"WebAuthentication","role":"symbol","type":"topic"}}} \ No newline at end of file +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents"]}],"metadata":{"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","role":"symbol","title":"safariProvider(style:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"safariProvider"},{"kind":"text","text":"("},{"text":"style","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"UIModalPresentationStyle","preciseIdentifier":"c:@E@UIModalPresentationStyle"},{"kind":"text","text":") -> "},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"}],"symbolKind":"method","externalID":"s:5Auth017WebAuthenticationV14safariProvider5styleAA0B13AuthUserAgent_p10Foundation3URLV_ys6ResultOyytAA0bG5ErrorVGctcSo24UIModalPresentationStyleV_tFZ","roleHeading":"Type Method"},"abstract":[{"type":"text","text":"Creates a Web Auth provider that uses "},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" as the external user agent."}],"variants":[{"paths":["\/documentation\/auth0\/webauthentication\/safariprovider(style:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"safariProvider","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle","kind":"typeIdentifier"},{"kind":"text","text":" = .fullScreen) -> "},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":"UIModalPresentationStyle"},{"type":"text","text":" to be used. Defaults to "},{"code":".fullScreen","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"style"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","type":"reference"},{"type":"text","text":" instance."}]}],"kind":"content"},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider())"," .start { result in"," \/\/ ...","}"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"If you need to specify a custom "},{"type":"codeVoice","code":"UIModalPresentationStyle"},{"type":"text","text":":"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider(style: .formSheet))"," .start { result in"," \/\/ ...","}"]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthProvider","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" to perform a web-based operation."},{"text":" ","type":"text"},{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" opens the URL in an external user agent and then invokes the callback when done."}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"url":"\/documentation\/auth0\/useragents","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"role":"article","type":"topic","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/safariProvider(style:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)","type":"topic","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"safariProvider"},{"kind":"text","text":"("},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"text":"UIModalPresentationStyle","preciseIdentifier":"c:@E@UIModalPresentationStyle","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier"}],"title":"safariProvider(style:)","abstract":[{"type":"text","text":"Creates a Web Auth provider that uses "},{"type":"codeVoice","code":"SFSafariViewController"},{"text":" as the external user agent.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthUserAgent"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthentication","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthentication","role":"symbol","title":"WebAuthentication","abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror.json b/docs/data/documentation/auth0/webautherror.json index 2545ec87..efa2e5f6 100644 --- a/docs/data/documentation/auth0/webautherror.json +++ b/docs/data/documentation/auth0/webautherror.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","interfaceLanguage":"swift"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd"],"title":"Operators"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription"],"title":"Instance Properties"},{"title":"Type Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"]},{"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations"],"generated":true}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror"]}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"platforms":["iOS"]}]}],"metadata":{"role":"symbol","symbolKind":"struct","modules":[{"name":"Auth0"}],"externalID":"s:5Auth012WebAuthErrorV","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"roleHeading":"Structure","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"title":"WebAuthError"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"schemaVersion":{"minor":3,"major":0,"patch":0},"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP"],"title":"Conforms To","type":"conformsTo"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/unknown":{"kind":"symbol","title":"unknown","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","type":"topic","url":"\/documentation\/auth0\/webautherror\/unknown","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"unknown","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}],"abstract":[{"text":"An unexpected error occurred, but an ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is not available."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":".","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"kind":"symbol","title":"userCancelled","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","type":"topic","url":"\/documentation\/auth0\/webautherror\/usercancelled","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"abstract":[{"type":"text","text":"The user cancelled the Web Auth operation."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/pkceNotAllowed":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"pkceNotAllowed","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}],"type":"topic","url":"\/documentation\/auth0\/webautherror\/pkcenotallowed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","kind":"symbol","title":"pkceNotAllowed","role":"symbol","abstract":[{"type":"text","text":"The Auth0 application does not support authentication with Proof Key for Code Exchange (PKCE)."},{"type":"text","text":" "},{"text":"PKCE support needs to be enabled in the settings page of the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":","},{"text":" ","type":"text"},{"type":"text","text":"by setting the "},{"type":"strong","inlineContent":[{"text":"Application Type","type":"text"}]},{"text":" to ‘Native’.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/idTokenValidationFailed":{"kind":"symbol","title":"idTokenValidationFailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","type":"topic","url":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"idTokenValidationFailed"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"abstract":[{"type":"text","text":"The ID token validation performed after authentication failed."},{"text":" ","type":"text"},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":" property."}],"role":"symbol"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/other":{"kind":"symbol","title":"other","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","type":"topic","url":"\/documentation\/auth0\/webautherror\/other","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"other"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"abstract":[{"type":"text","text":"An unexpected error occurred, and an "},{"type":"codeVoice","code":"Error"},{"text":" value is available.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"text":" value can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":" property."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-3690":{"abstract":[{"type":"text","text":"Matches "},{"code":"WebAuthError","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","title":"~=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/auth0error-implementations","title":"Auth0Error Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noBundleIdentifier":{"abstract":[{"type":"text","text":"The bundle identifier could not be retrieved from "},{"type":"codeVoice","code":"Bundle.main.bundleIdentifier"},{"text":", or it could not be used to","type":"text"},{"type":"text","text":" "},{"type":"text","text":"build a valid URL."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/nobundleidentifier","title":"noBundleIdentifier","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noBundleIdentifier","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/invalidInvitationURL":{"abstract":[{"type":"text","text":"The invitation URL is missing the "},{"code":"invitation","type":"codeVoice"},{"type":"text","text":" and\/or the "},{"type":"codeVoice","code":"organization"},{"type":"text","text":" query parameters."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":"."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/invalidinvitationurl","title":"invalidInvitationURL","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invalidInvitationURL"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"https://manage.auth0.com/#/applications/":{"titleInlineContent":[{"type":"text","text":"Auth0 application"}],"title":"Auth0 application","type":"link","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","url":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noAuthorizationCode":{"abstract":[{"type":"text","text":"The callback URL is missing the "},{"type":"codeVoice","code":"code"},{"text":" query parameter.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/noauthorizationcode","title":"noAuthorizationCode","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"noAuthorizationCode"},{"kind":"text","text":": "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"role":"symbol"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/debugDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/debugdescription","title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","title":"LocalizedError Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/cause":{"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/cause","title":"cause","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-6ibkd":{"abstract":[{"type":"text","text":"Matches "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","title":"~=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/s5ErrorP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/equatable-implementations","title":"Equatable Implementations","role":"collectionGroup"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"role":"symbol","roleHeading":"Structure","title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"WebAuthError","kind":"identifier"}],"symbolKind":"struct","modules":[{"name":"Auth0"}],"externalID":"s:5Auth012WebAuthErrorV"},"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP"],"title":"Conforms To","kind":"relationships"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}]}]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd"],"title":"Operators"},{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription"]},{"title":"Type Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/transactionActiveAlready","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"]},{"generated":true,"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations"]}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webautherror"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","type":"topic","abstract":[],"kind":"article","title":"LocalizedError Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/transactionActiveAlready":{"abstract":[{"type":"text","text":"There is already an active transaction at the moment; therefore, this newly initiated transaction is canceled."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"title":"transactionActiveAlready","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"transactionActiveAlready"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/transactionActiveAlready","url":"\/documentation\/auth0\/webautherror\/transactionactivealready","kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noAuthorizationCode":{"abstract":[{"text":"The callback URL is missing the ","type":"text"},{"type":"codeVoice","code":"code"},{"type":"text","text":" query parameter."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"title":"noAuthorizationCode","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"noAuthorizationCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","url":"\/documentation\/auth0\/webautherror\/noauthorizationcode","kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/cause":{"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","title":"cause","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"?","kind":"text"}],"type":"topic","url":"\/documentation\/auth0\/webautherror\/cause"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/unknown":{"abstract":[{"text":"An unexpected error occurred, but an ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is not available."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":".","type":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","title":"unknown","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webautherror\/unknown","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/pkceNotAllowed":{"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"pkceNotAllowed","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webautherror\/pkcenotallowed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","title":"pkceNotAllowed","role":"symbol","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"The Auth0 application does not support authentication with Proof Key for Code Exchange (PKCE)."},{"type":"text","text":" "},{"type":"text","text":"PKCE support needs to be enabled in the settings page of the "},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true,"type":"reference"},{"text":",","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"by setting the "},{"inlineContent":[{"type":"text","text":"Application Type"}],"type":"strong"},{"text":" to ‘Native’.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","url":"\/documentation\/auth0\/webautherror\/equatable-implementations","abstract":[],"type":"topic","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations"},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable","title":"Swift.Error"},"https://manage.auth0.com/#/applications/":{"title":"Auth0 application","titleInlineContent":[{"text":"Auth0 application","type":"text"}],"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","url":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"role":"collectionGroup","title":"Auth0Error Implementations","abstract":[],"kind":"article","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/webautherror\/auth0error-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/other":{"title":"other","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"other","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","url":"\/documentation\/auth0\/webautherror\/other","role":"symbol","abstract":[{"text":"An unexpected error occurred, and an ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is available."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"text":" value can be accessed via the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":" property.","type":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Auth0Error"}],"url":"\/documentation\/auth0\/auth0error","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"kind":"symbol","title":"Auth0Error"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/idTokenValidationFailed":{"abstract":[{"text":"The ID token validation performed after authentication failed.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":" property.","type":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","title":"idTokenValidationFailed","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"idTokenValidationFailed","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","url":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"url":"\/documentation\/auth0\/webautherror\/usercancelled","title":"userCancelled","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","abstract":[{"text":"The user cancelled the Web Auth operation.","type":"text"},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/invalidInvitationURL":{"title":"invalidInvitationURL","type":"topic","abstract":[{"type":"text","text":"The invitation URL is missing the "},{"type":"codeVoice","code":"invitation"},{"type":"text","text":" and\/or the "},{"code":"organization","type":"codeVoice"},{"text":" query parameters.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"invalidInvitationURL"},{"kind":"text","text":": "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","role":"symbol","url":"\/documentation\/auth0\/webautherror\/invalidinvitationurl"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/debugDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"type":"topic","url":"\/documentation\/auth0\/webautherror\/debugdescription"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-6ibkd":{"url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":", "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" values in a switch statement."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","title":"~=(_:_:)","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noBundleIdentifier":{"title":"noBundleIdentifier","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"noBundleIdentifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webautherror\/nobundleidentifier","abstract":[{"type":"text","text":"The bundle identifier could not be retrieved from "},{"code":"Bundle.main.bundleIdentifier","type":"codeVoice"},{"type":"text","text":", or it could not be used to"},{"text":" ","type":"text"},{"type":"text","text":"build a valid URL."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-3690":{"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"WebAuthError"},{"text":" values in a switch statement.","type":"text"}],"url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","title":"~=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","kind":"symbol","role":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/!=(_:_:).json b/docs/data/documentation/auth0/webautherror/!=(_:_:).json index ae3a24de..9d7e3098 100644 --- a/docs/data/documentation/auth0/webautherror/!=(_:_:).json +++ b/docs/data/documentation/auth0/webautherror/!=(_:_:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Inherited from "},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/!=(_:_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","interfaceLanguage":"swift"},"metadata":{"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth012WebAuthErrorV","extendedModule":"Swift","title":"!=(_:_:)","symbolKind":"op","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","roleHeading":"Operator","modules":[{"relatedModules":["Swift"],"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/!=(_:_:)":{"url":"\/documentation\/auth0\/webautherror\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","type":"topic","abstract":[],"kind":"symbol","title":"!=(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/equatable-implementations","title":"Equatable Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations"]]},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","metadata":{"symbolKind":"op","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"roleHeading":"Operator","title":"!=(_:_:)","extendedModule":"Swift","role":"symbol","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth012WebAuthErrorV"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)"},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","url":"\/documentation\/auth0\/webautherror\/equatable-implementations","abstract":[],"type":"topic","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/!=(_:_:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/webautherror\/!=(_:_:)","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"!=(_:_:)","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/==(_:_:).json b/docs/data/documentation/auth0/webautherror/==(_:_:).json index c9be97d5..73d361f5 100644 --- a/docs/data/documentation/auth0/webautherror/==(_:_:).json +++ b/docs/data/documentation/auth0/webautherror/==(_:_:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/==(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"==(_:_:)","role":"symbol","symbolKind":"op","roleHeading":"Operator","externalID":"s:5Auth012WebAuthErrorV2eeoiySbAC_ACtFZ","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"=="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations"]]},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/==(_:_:)":{"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","kind":"symbol","title":"==(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/equatable-implementations","title":"Equatable Implementations","role":"collectionGroup"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations"]]},"sections":[],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"==(_:_:)","roleHeading":"Operator","externalID":"s:5Auth012WebAuthErrorV2eeoiySbAC_ACtFZ","extendedModule":"Auth0","symbolKind":"op","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/==(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/==(_:_:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/webautherror\/==(_:_:)","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","url":"\/documentation\/auth0\/webautherror\/equatable-implementations","abstract":[],"type":"topic","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/auth0error-implementations.json b/docs/data/documentation/auth0/webautherror/auth0error-implementations.json index fdb4913f..9a09b354 100644 --- a/docs/data/documentation/auth0/webautherror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/webautherror/auth0error-implementations.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"kind":"article","topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription"],"title":"Instance Properties"}],"metadata":{"title":"Auth0Error Implementations","roleHeading":"API Collection","role":"collectionGroup","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/auth0error-implementations"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/localizedDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"url":"\/documentation\/auth0\/webautherror\/localizeddescription","type":"topic","title":"localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/errorDescription":{"role":"symbol","title":"errorDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","url":"\/documentation\/auth0\/webautherror\/errordescription","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}]}}} \ No newline at end of file +{"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/auth0error-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","roleHeading":"API Collection","title":"Auth0Error Implementations"},"topicSections":[{"generated":true,"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"article","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/localizedDescription":{"role":"symbol","type":"topic","abstract":[{"text":"Description of the error.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/auth0\/webautherror\/localizeddescription","title":"localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/errorDescription":{"role":"symbol","title":"errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/webautherror\/errordescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/cause.json b/docs/data/documentation/auth0/webautherror/cause.json index b6494d7f..122b9787 100644 --- a/docs/data/documentation/auth0/webautherror/cause.json +++ b/docs/data/documentation/auth0/webautherror/cause.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","interfaceLanguage":"swift"},"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"externalID":"s:5Auth012WebAuthErrorV5causes0D0_pSgvp","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"title":"cause"},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/cause"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/cause":{"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/cause","title":"cause","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"cause","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"role":"symbol","externalID":"s:5Auth012WebAuthErrorV5causes0D0_pSgvp"},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/cause"]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/cause":{"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","title":"cause","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":"?","kind":"text"}],"type":"topic","url":"\/documentation\/auth0\/webautherror\/cause"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/debugdescription.json b/docs/data/documentation/auth0/webautherror/debugdescription.json index d5a31835..432662d2 100644 --- a/docs/data/documentation/auth0/webautherror/debugdescription.json +++ b/docs/data/documentation/auth0/webautherror/debugdescription.json @@ -1 +1 @@ -{"metadata":{"title":"debugDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"symbolKind":"property","externalID":"s:5Auth012WebAuthErrorV16debugDescriptionSSvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"name":"Important","style":"important","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"text":" only.","type":"text"}]}]}],"kind":"content"}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/debugdescription"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Description of the error."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/debugDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/debugdescription","title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"style":"important","name":"Important","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"type":"text","text":" only."}]}]}]}],"metadata":{"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"title":"debugDescription","role":"symbol","symbolKind":"property","externalID":"s:5Auth012WebAuthErrorV16debugDescriptionSSvp"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"abstract":[{"type":"text","text":"Description of the error."}],"sections":[],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webautherror\/debugdescription"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/debugDescription":{"abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"type":"topic","url":"\/documentation\/auth0\/webautherror\/debugdescription"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/equatable-implementations.json b/docs/data/documentation/auth0/webautherror/equatable-implementations.json index 2491aebd..206478ba 100644 --- a/docs/data/documentation/auth0/webautherror/equatable-implementations.json +++ b/docs/data/documentation/auth0/webautherror/equatable-implementations.json @@ -1 +1 @@ -{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","interfaceLanguage":"swift"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)"],"generated":true,"title":"Operators"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/equatable-implementations"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"article","metadata":{"title":"Equatable Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/!=(_:_:)":{"url":"\/documentation\/auth0\/webautherror\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","type":"topic","abstract":[],"kind":"symbol","title":"!=(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/==(_:_:)":{"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","kind":"symbol","title":"==(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"role":"collectionGroup","roleHeading":"API Collection","modules":[{"name":"Auth0"}],"title":"Equatable Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"article","sections":[],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)"],"generated":true,"title":"Operators"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/==(_:_:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/webautherror\/==(_:_:)","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/!=(_:_:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/webautherror\/!=(_:_:)","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"!=(_:_:)","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/errordescription.json b/docs/data/documentation/auth0/webautherror/errordescription.json index 5bb4eb6a..874b0c67 100644 --- a/docs/data/documentation/auth0/webautherror/errordescription.json +++ b/docs/data/documentation/auth0/webautherror/errordescription.json @@ -1 +1 @@ -{"abstract":[{"text":"Description of the error.","type":"text"}],"metadata":{"externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","role":"symbol","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","title":"errorDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"symbolKind":"property","roleHeading":"Instance Property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"aside","style":"important","name":"Important","content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"type":"strong","inlineContent":[{"text":"debugging","type":"text"}]},{"text":" only.","type":"text"}]}]}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/errordescription"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription"},"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations"]]},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/errorDescription":{"role":"symbol","title":"errorDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","url":"\/documentation\/auth0\/webautherror\/errordescription","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/auth0error-implementations","title":"Auth0Error Implementations","role":"collectionGroup"}}} \ No newline at end of file +{"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","interfaceLanguage":"swift"},"metadata":{"symbolKind":"property","title":"errorDescription","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","extendedModule":"Auth0","role":"symbol"},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"style":"important","type":"aside","content":[{"inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"type":"strong","inlineContent":[{"text":"debugging","type":"text"}]},{"type":"text","text":" only."}],"type":"paragraph"}],"name":"Important"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/errordescription"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/errorDescription":{"role":"symbol","title":"errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/webautherror\/errordescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"role":"collectionGroup","title":"Auth0Error Implementations","abstract":[],"kind":"article","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/webautherror\/auth0error-implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/failurereason.json b/docs/data/documentation/auth0/webautherror/failurereason.json index 38d5f6e8..73348fa4 100644 --- a/docs/data/documentation/auth0/webautherror/failurereason.json +++ b/docs/data/documentation/auth0/webautherror/failurereason.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/failurereason"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations"]]},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"text":".","type":"text"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"role":"symbol","platforms":[{"beta":false,"deprecated":false,"introducedAt":"8.0","name":"iOS","unavailable":false},{"name":"macOS","unavailable":false,"beta":false,"deprecated":false,"introducedAt":"10.10"},{"unavailable":false,"name":"tvOS","beta":false,"introducedAt":"9.0","deprecated":false},{"introducedAt":"2.0","name":"watchOS","unavailable":false,"deprecated":false,"beta":false}],"title":"failureReason","extendedModule":"Foundation","roleHeading":"Instance Property","externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"symbolKind":"property"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason"},"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","title":"LocalizedError Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/failureReason":{"role":"symbol","url":"\/documentation\/auth0\/webautherror\/failurereason","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"kind":"symbol","abstract":[],"title":"failureReason"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","sections":[],"metadata":{"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"extendedModule":"Foundation","role":"symbol","title":"failureReason","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"symbolKind":"property","externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","roleHeading":"Instance Property","platforms":[{"unavailable":false,"beta":false,"deprecated":false,"introducedAt":"8.0","name":"iOS"},{"deprecated":false,"introducedAt":"10.10","beta":false,"name":"macOS","unavailable":false},{"unavailable":false,"deprecated":false,"beta":false,"introducedAt":"9.0","name":"tvOS"},{"unavailable":false,"beta":false,"introducedAt":"2.0","deprecated":false,"name":"watchOS"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}]}]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/failurereason"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","type":"topic","abstract":[],"kind":"article","title":"LocalizedError Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/failureReason":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"failureReason","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/failurereason","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/helpanchor.json b/docs/data/documentation/auth0/webautherror/helpanchor.json index f67f6a6e..fe200017 100644 --- a/docs/data/documentation/auth0/webautherror/helpanchor.json +++ b/docs/data/documentation/auth0/webautherror/helpanchor.json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.helpAnchor","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","interfaceLanguage":"swift"},"metadata":{"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","platforms":[{"introducedAt":"8.0","beta":false,"deprecated":false,"unavailable":false,"name":"iOS"},{"name":"macOS","introducedAt":"10.10","unavailable":false,"beta":false,"deprecated":false},{"beta":false,"unavailable":false,"introducedAt":"9.0","deprecated":false,"name":"tvOS"},{"deprecated":false,"unavailable":false,"introducedAt":"2.0","name":"watchOS","beta":false}],"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"role":"symbol","extendedModule":"Foundation","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","title":"helpAnchor"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations"]]},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/helpAnchor":{"kind":"symbol","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","title":"helpAnchor","url":"\/documentation\/auth0\/webautherror\/helpanchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","title":"LocalizedError Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/webautherror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"extendedModule":"Foundation","symbolKind":"property","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"helpAnchor","roleHeading":"Instance Property","role":"symbol","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","platforms":[{"deprecated":false,"beta":false,"unavailable":false,"introducedAt":"8.0","name":"iOS"},{"introducedAt":"10.10","beta":false,"deprecated":false,"name":"macOS","unavailable":false},{"introducedAt":"9.0","beta":false,"name":"tvOS","deprecated":false,"unavailable":false},{"name":"watchOS","unavailable":false,"introducedAt":"2.0","deprecated":false,"beta":false}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.helpAnchor","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","type":"topic","abstract":[],"kind":"article","title":"LocalizedError Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/helpAnchor":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"helpAnchor","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/helpanchor","abstract":[]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/idtokenvalidationfailed.json b/docs/data/documentation/auth0/webautherror/idtokenvalidationfailed.json index 3395f813..a5344cd8 100644 --- a/docs/data/documentation/auth0/webautherror/idtokenvalidationfailed.json +++ b/docs/data/documentation/auth0/webautherror/idtokenvalidationfailed.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idTokenValidationFailed"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","metadata":{"externalID":"s:5Auth012WebAuthErrorV23idTokenValidationFailedACvpZ","role":"symbol","symbolKind":"property","roleHeading":"Type Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"idTokenValidationFailed"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"title":"idTokenValidationFailed"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/idtokenvalidationfailed"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"The ID token validation performed after authentication failed.","type":"text"},{"type":"text","text":" "},{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value can be accessed via the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":" property."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/idTokenValidationFailed":{"kind":"symbol","title":"idTokenValidationFailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","type":"topic","url":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"idTokenValidationFailed"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"abstract":[{"type":"text","text":"The ID token validation performed after authentication failed."},{"text":" ","type":"text"},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":" property."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"title":"idTokenValidationFailed","modules":[{"name":"Auth0"}],"roleHeading":"Type Property","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"idTokenValidationFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"symbolKind":"property","externalID":"s:5Auth012WebAuthErrorV23idTokenValidationFailedACvpZ","role":"symbol"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"idTokenValidationFailed"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier"}],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/idtokenvalidationfailed"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"symbol","abstract":[{"text":"The ID token validation performed after authentication failed.","type":"text"},{"type":"text","text":" "},{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value can be accessed via the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":" property."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/idTokenValidationFailed":{"abstract":[{"text":"The ID token validation performed after authentication failed.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":" property.","type":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","title":"idTokenValidationFailed","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"idTokenValidationFailed","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","url":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/invalidinvitationurl.json b/docs/data/documentation/auth0/webautherror/invalidinvitationurl.json index 1f95d414..91c22e81 100644 --- a/docs/data/documentation/auth0/webautherror/invalidinvitationurl.json +++ b/docs/data/documentation/auth0/webautherror/invalidinvitationurl.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"invalidInvitationURL","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}]}],"kind":"declarations"}],"metadata":{"symbolKind":"property","roleHeading":"Type Property","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invalidInvitationURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth012WebAuthErrorV20invalidInvitationURLACvpZ","title":"invalidInvitationURL"},"abstract":[{"text":"The invitation URL is missing the ","type":"text"},{"type":"codeVoice","code":"invitation"},{"type":"text","text":" and\/or the "},{"type":"codeVoice","code":"organization"},{"text":" query parameters.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/invalidinvitationurl"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/invalidInvitationURL":{"abstract":[{"type":"text","text":"The invitation URL is missing the "},{"code":"invitation","type":"codeVoice"},{"type":"text","text":" and\/or the "},{"type":"codeVoice","code":"organization"},{"type":"text","text":" query parameters."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":"."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/invalidinvitationurl","title":"invalidInvitationURL","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"invalidInvitationURL"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/invalidinvitationurl"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"symbol","metadata":{"roleHeading":"Type Property","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"invalidInvitationURL","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth012WebAuthErrorV20invalidInvitationURLACvpZ","symbolKind":"property","title":"invalidInvitationURL"},"sections":[],"abstract":[{"type":"text","text":"The invitation URL is missing the "},{"type":"codeVoice","code":"invitation"},{"text":" and\/or the ","type":"text"},{"type":"codeVoice","code":"organization"},{"type":"text","text":" query parameters."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"invalidInvitationURL","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/invalidInvitationURL":{"title":"invalidInvitationURL","type":"topic","abstract":[{"type":"text","text":"The invitation URL is missing the "},{"type":"codeVoice","code":"invitation"},{"type":"text","text":" and\/or the "},{"code":"organization","type":"codeVoice"},{"text":" query parameters.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"invalidInvitationURL"},{"kind":"text","text":": "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","role":"symbol","url":"\/documentation\/auth0\/webautherror\/invalidinvitationurl"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/localizeddescription.json b/docs/data/documentation/auth0/webautherror/localizeddescription.json index 3e5a0008..66d2df0f 100644 --- a/docs/data/documentation/auth0/webautherror/localizeddescription.json +++ b/docs/data/documentation/auth0/webautherror/localizeddescription.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]},{"content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"type":"aside","style":"important","content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"type":"text","text":" only."}]}],"name":"Important"}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations"]]},"kind":"symbol","metadata":{"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","role":"symbol","symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"localizedDescription","extendedModule":"Auth0"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","interfaceLanguage":"swift"},"sections":[],"abstract":[{"type":"text","text":"Description of the error."}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/auth0error-implementations","title":"Auth0Error Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/localizedDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"url":"\/documentation\/auth0\/webautherror\/localizeddescription","type":"topic","title":"localizedDescription"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"name":"Important","content":[{"inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"type":"text","text":" only."}],"type":"paragraph"}],"type":"aside","style":"important"}]}],"metadata":{"roleHeading":"Instance Property","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"symbolKind":"property","role":"symbol","title":"localizedDescription"},"abstract":[{"type":"text","text":"Description of the error."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/localizeddescription"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations"]]},"sections":[],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/localizedDescription":{"role":"symbol","type":"topic","abstract":[{"text":"Description of the error.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/auth0\/webautherror\/localizeddescription","title":"localizedDescription"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"role":"collectionGroup","title":"Auth0Error Implementations","abstract":[],"kind":"article","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/webautherror\/auth0error-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/localizederror-implementations.json b/docs/data/documentation/auth0/webautherror/localizederror-implementations.json index bc662fa0..cadd5cb7 100644 --- a/docs/data/documentation/auth0/webautherror/localizederror-implementations.json +++ b/docs/data/documentation/auth0/webautherror/localizederror-implementations.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion"],"title":"Instance Properties"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/localizederror-implementations"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"role":"collectionGroup","title":"LocalizedError Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/helpAnchor":{"kind":"symbol","type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","title":"helpAnchor","url":"\/documentation\/auth0\/webautherror\/helpanchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/recoverySuggestion":{"role":"symbol","url":"\/documentation\/auth0\/webautherror\/recoverysuggestion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","kind":"symbol","type":"topic","abstract":[],"title":"recoverySuggestion","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/failureReason":{"role":"symbol","url":"\/documentation\/auth0\/webautherror\/failurereason","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"kind":"symbol","abstract":[],"title":"failureReason"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion"],"generated":true}],"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/localizederror-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"role":"collectionGroup","roleHeading":"API Collection","title":"LocalizedError Implementations","modules":[{"name":"Auth0"}]},"kind":"article","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/helpAnchor":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"helpAnchor","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/helpanchor","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/recoverySuggestion":{"abstract":[],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic","title":"recoverySuggestion","url":"\/documentation\/auth0\/webautherror\/recoverysuggestion","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/failureReason":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic","title":"failureReason","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/failurereason","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/noauthorizationcode.json b/docs/data/documentation/auth0/webautherror/noauthorizationcode.json index f383dfb9..2a8609a0 100644 --- a/docs/data/documentation/auth0/webautherror/noauthorizationcode.json +++ b/docs/data/documentation/auth0/webautherror/noauthorizationcode.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"The callback URL is missing the "},{"code":"code","type":"codeVoice"},{"type":"text","text":" query parameter."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"text":".","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noAuthorizationCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier"}]}]}],"metadata":{"role":"symbol","title":"noAuthorizationCode","roleHeading":"Type Property","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noAuthorizationCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"externalID":"s:5Auth012WebAuthErrorV19noAuthorizationCodeACvpZ","symbolKind":"property","modules":[{"name":"Auth0"}]},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/noauthorizationcode"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noAuthorizationCode":{"abstract":[{"type":"text","text":"The callback URL is missing the "},{"type":"codeVoice","code":"code"},{"text":" query parameter.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/noauthorizationcode","title":"noAuthorizationCode","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"noAuthorizationCode"},{"kind":"text","text":": "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"sections":[],"abstract":[{"type":"text","text":"The callback URL is missing the "},{"type":"codeVoice","code":"code"},{"type":"text","text":" query parameter."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":".","type":"text"}],"metadata":{"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"noAuthorizationCode","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","roleHeading":"Type Property","title":"noAuthorizationCode","externalID":"s:5Auth012WebAuthErrorV19noAuthorizationCodeACvpZ"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"noAuthorizationCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/noauthorizationcode"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noAuthorizationCode":{"abstract":[{"text":"The callback URL is missing the ","type":"text"},{"type":"codeVoice","code":"code"},{"type":"text","text":" query parameter."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"title":"noAuthorizationCode","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"noAuthorizationCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","url":"\/documentation\/auth0\/webautherror\/noauthorizationcode","kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/nobundleidentifier.json b/docs/data/documentation/auth0/webautherror/nobundleidentifier.json index 693cd8b7..b2db8849 100644 --- a/docs/data/documentation/auth0/webautherror/nobundleidentifier.json +++ b/docs/data/documentation/auth0/webautherror/nobundleidentifier.json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The bundle identifier could not be retrieved from "},{"type":"codeVoice","code":"Bundle.main.bundleIdentifier"},{"type":"text","text":", or it could not be used to"},{"type":"text","text":" "},{"type":"text","text":"build a valid URL."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":".","type":"text"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"noBundleIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"metadata":{"title":"noBundleIdentifier","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noBundleIdentifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth012WebAuthErrorV18noBundleIdentifierACvpZ","roleHeading":"Type Property"},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/nobundleidentifier"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noBundleIdentifier":{"abstract":[{"type":"text","text":"The bundle identifier could not be retrieved from "},{"type":"codeVoice","code":"Bundle.main.bundleIdentifier"},{"text":", or it could not be used to","type":"text"},{"type":"text","text":" "},{"type":"text","text":"build a valid URL."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/nobundleidentifier","title":"noBundleIdentifier","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"noBundleIdentifier","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"noBundleIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"languages":["swift"],"platforms":["iOS"]}]}],"abstract":[{"type":"text","text":"The bundle identifier could not be retrieved from "},{"code":"Bundle.main.bundleIdentifier","type":"codeVoice"},{"type":"text","text":", or it could not be used to"},{"type":"text","text":" "},{"type":"text","text":"build a valid URL."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":"."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"externalID":"s:5Auth012WebAuthErrorV18noBundleIdentifierACvpZ","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noBundleIdentifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"title":"noBundleIdentifier","roleHeading":"Type Property","symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/nobundleidentifier"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noBundleIdentifier":{"title":"noBundleIdentifier","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"noBundleIdentifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webautherror\/nobundleidentifier","abstract":[{"type":"text","text":"The bundle identifier could not be retrieved from "},{"code":"Bundle.main.bundleIdentifier","type":"codeVoice"},{"type":"text","text":", or it could not be used to"},{"text":" ","type":"text"},{"type":"text","text":"build a valid URL."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":"."}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/other.json b/docs/data/documentation/auth0/webautherror/other.json index 388d5169..2a552a44 100644 --- a/docs/data/documentation/auth0/webautherror/other.json +++ b/docs/data/documentation/auth0/webautherror/other.json @@ -1 +1 @@ -{"metadata":{"symbolKind":"property","roleHeading":"Type Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"other","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"role":"symbol","title":"other","externalID":"s:5Auth012WebAuthErrorV5otherACvpZ"},"abstract":[{"text":"An unexpected error occurred, and an ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value is available.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value can be accessed via the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":" property."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/other"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"other"},{"text":": ","kind":"text"},{"text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/other":{"kind":"symbol","title":"other","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","type":"topic","url":"\/documentation\/auth0\/webautherror\/other","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"other"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"abstract":[{"type":"text","text":"An unexpected error occurred, and an "},{"type":"codeVoice","code":"Error"},{"text":" value is available.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"text":" value can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":" property."}],"role":"symbol"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"other"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"metadata":{"externalID":"s:5Auth012WebAuthErrorV5otherACvpZ","roleHeading":"Type Property","symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"other"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"title":"other"},"abstract":[{"type":"text","text":"An unexpected error occurred, and an "},{"type":"codeVoice","code":"Error"},{"text":" value is available.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value can be accessed via the ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/other"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/other":{"title":"other","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"other","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","url":"\/documentation\/auth0\/webautherror\/other","role":"symbol","abstract":[{"text":"An unexpected error occurred, and an ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is available."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"text":" value can be accessed via the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":" property.","type":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/pkcenotallowed.json b/docs/data/documentation/auth0/webautherror/pkcenotallowed.json index 362487b8..7db9c95c 100644 --- a/docs/data/documentation/auth0/webautherror/pkcenotallowed.json +++ b/docs/data/documentation/auth0/webautherror/pkcenotallowed.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"pkceNotAllowed"},{"kind":"text","text":": "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"pkceNotAllowed","externalID":"s:5Auth012WebAuthErrorV14pkceNotAllowedACvpZ","roleHeading":"Type Property","role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/pkcenotallowed"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"pkceNotAllowed"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"}],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"The Auth0 application does not support authentication with Proof Key for Code Exchange (PKCE)."},{"type":"text","text":" "},{"text":"PKCE support needs to be enabled in the settings page of the ","type":"text"},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true},{"type":"text","text":","},{"text":" ","type":"text"},{"text":"by setting the ","type":"text"},{"inlineContent":[{"text":"Application Type","type":"text"}],"type":"strong"},{"type":"text","text":" to ‘Native’."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"type":"text","text":"Auth0 application"}],"title":"Auth0 application","url":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/pkceNotAllowed":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"pkceNotAllowed","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}],"type":"topic","url":"\/documentation\/auth0\/webautherror\/pkcenotallowed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","kind":"symbol","title":"pkceNotAllowed","role":"symbol","abstract":[{"type":"text","text":"The Auth0 application does not support authentication with Proof Key for Code Exchange (PKCE)."},{"type":"text","text":" "},{"text":"PKCE support needs to be enabled in the settings page of the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":","},{"text":" ","type":"text"},{"type":"text","text":"by setting the "},{"type":"strong","inlineContent":[{"text":"Application Type","type":"text"}]},{"text":" to ‘Native’.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/webautherror\/pkcenotallowed"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"pkceNotAllowed","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"title":"pkceNotAllowed","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth012WebAuthErrorV14pkceNotAllowedACvpZ","roleHeading":"Type Property","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"pkceNotAllowed"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError"}]}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"The Auth0 application does not support authentication with Proof Key for Code Exchange (PKCE)."},{"type":"text","text":" "},{"type":"text","text":"PKCE support needs to be enabled in the settings page of the "},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference"},{"text":",","type":"text"},{"type":"text","text":" "},{"type":"text","text":"by setting the "},{"type":"strong","inlineContent":[{"type":"text","text":"Application Type"}]},{"text":" to ‘Native’.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/pkceNotAllowed":{"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"pkceNotAllowed","kind":"identifier"},{"kind":"text","text":": "},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webautherror\/pkcenotallowed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","title":"pkceNotAllowed","role":"symbol","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"The Auth0 application does not support authentication with Proof Key for Code Exchange (PKCE)."},{"type":"text","text":" "},{"type":"text","text":"PKCE support needs to be enabled in the settings page of the "},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true,"type":"reference"},{"text":",","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"by setting the "},{"inlineContent":[{"type":"text","text":"Application Type"}],"type":"strong"},{"text":" to ‘Native’.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"https://manage.auth0.com/#/applications/":{"url":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"type":"text","text":"Auth0 application"}],"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Auth0 application","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/recoverysuggestion.json b/docs/data/documentation/auth0/webautherror/recoverysuggestion.json index 3389b187..3a669992 100644 --- a/docs/data/documentation/auth0/webautherror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/webautherror/recoverysuggestion.json @@ -1 +1 @@ -{"metadata":{"title":"recoverySuggestion","extendedModule":"Foundation","platforms":[{"unavailable":false,"deprecated":false,"name":"iOS","introducedAt":"8.0","beta":false},{"deprecated":false,"introducedAt":"10.10","name":"macOS","beta":false,"unavailable":false},{"unavailable":false,"name":"tvOS","introducedAt":"9.0","deprecated":false,"beta":false},{"name":"watchOS","deprecated":false,"introducedAt":"2.0","beta":false,"unavailable":false}],"symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","roleHeading":"Instance Property","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations"]]},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.recoverySuggestion"},{"type":"text","text":"."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/recoverySuggestion":{"role":"symbol","url":"\/documentation\/auth0\/webautherror\/recoverysuggestion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","kind":"symbol","type":"topic","abstract":[],"title":"recoverySuggestion","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","kind":"article","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","title":"LocalizedError Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"metadata":{"title":"recoverySuggestion","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","extendedModule":"Foundation","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"symbolKind":"property","platforms":[{"introducedAt":"8.0","beta":false,"unavailable":false,"name":"iOS","deprecated":false},{"beta":false,"unavailable":false,"name":"macOS","deprecated":false,"introducedAt":"10.10"},{"introducedAt":"9.0","name":"tvOS","deprecated":false,"beta":false,"unavailable":false},{"name":"watchOS","deprecated":false,"beta":false,"introducedAt":"2.0","unavailable":false}],"role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"text":".","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/recoverysuggestion"]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/recoverySuggestion":{"abstract":[],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic","title":"recoverySuggestion","url":"\/documentation\/auth0\/webautherror\/recoverysuggestion","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","type":"topic","abstract":[],"kind":"article","title":"LocalizedError Implementations","role":"collectionGroup"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/transactionactivealready.json b/docs/data/documentation/auth0/webautherror/transactionactivealready.json new file mode 100644 index 00000000..7afcc777 --- /dev/null +++ b/docs/data/documentation/auth0/webautherror/transactionactivealready.json @@ -0,0 +1 @@ +{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/transactionActiveAlready","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/transactionactivealready"]}],"metadata":{"symbolKind":"property","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"transactionActiveAlready","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"roleHeading":"Type Property","role":"symbol","externalID":"s:5Auth012WebAuthErrorV24transactionActiveAlreadyACvpZ","title":"transactionActiveAlready","modules":[{"name":"Auth0"}]},"abstract":[{"text":"There is already an active transaction at the moment; therefore, this newly initiated transaction is canceled.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"transactionActiveAlready","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier"}]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/transactionActiveAlready":{"abstract":[{"type":"text","text":"There is already an active transaction at the moment; therefore, this newly initiated transaction is canceled."},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"title":"transactionActiveAlready","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"transactionActiveAlready"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/transactionActiveAlready","url":"\/documentation\/auth0\/webautherror\/transactionactivealready","kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/unknown.json b/docs/data/documentation/auth0/webautherror/unknown.json index 7e4b2350..57b66512 100644 --- a/docs/data/documentation/auth0/webautherror/unknown.json +++ b/docs/data/documentation/auth0/webautherror/unknown.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unknown","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"symbolKind":"property","title":"unknown","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Type Property","externalID":"s:5Auth012WebAuthErrorV7unknownACvpZ","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"unknown"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}]},"abstract":[{"text":"An unexpected error occurred, but an ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is not available."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/unknown"]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/unknown":{"kind":"symbol","title":"unknown","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","type":"topic","url":"\/documentation\/auth0\/webautherror\/unknown","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"unknown","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}],"abstract":[{"text":"An unexpected error occurred, but an ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is not available."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":".","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"unknown","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"symbolKind":"property","externalID":"s:5Auth012WebAuthErrorV7unknownACvpZ","roleHeading":"Type Property","title":"unknown"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown"},"abstract":[{"type":"text","text":"An unexpected error occurred, but an "},{"code":"Error","type":"codeVoice"},{"text":" value is not available.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"unknown","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/unknown"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/unknown":{"abstract":[{"text":"An unexpected error occurred, but an ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is not available."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":".","type":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","title":"unknown","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webautherror\/unknown","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/usercancelled.json b/docs/data/documentation/auth0/webautherror/usercancelled.json index 4f3f4632..32f851ad 100644 --- a/docs/data/documentation/auth0/webautherror/usercancelled.json +++ b/docs/data/documentation/auth0/webautherror/usercancelled.json @@ -1 +1 @@ -{"metadata":{"role":"symbol","symbolKind":"property","externalID":"s:5Auth012WebAuthErrorV13userCancelledACvpZ","roleHeading":"Type Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"userCancelled","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"title":"userCancelled"},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/usercancelled"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"abstract":[{"type":"text","text":"The user cancelled the Web Auth operation."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"userCancelled","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier"}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"kind":"symbol","title":"userCancelled","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","type":"topic","url":"\/documentation\/auth0\/webautherror\/usercancelled","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"abstract":[{"type":"text","text":"The user cancelled the Web Auth operation."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","type":"topic","abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"}}} \ No newline at end of file +{"metadata":{"roleHeading":"Type Property","title":"userCancelled","symbolKind":"property","externalID":"s:5Auth012WebAuthErrorV13userCancelledACvpZ","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"userCancelled","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The user cancelled the Web Auth operation."},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"userCancelled"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/usercancelled"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"url":"\/documentation\/auth0\/webautherror\/usercancelled","title":"userCancelled","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","abstract":[{"text":"The user cancelled the Web Auth operation.","type":"text"},{"type":"text","text":" "},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"cause","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/~=(_:_:)-3690.json b/docs/data/documentation/auth0/webautherror/~=(_:_:)-3690.json index f446edbc..9ec37a4e 100644 --- a/docs/data/documentation/auth0/webautherror/~=(_:_:)-3690.json +++ b/docs/data/documentation/auth0/webautherror/~=(_:_:)-3690.json @@ -1 +1 @@ -{"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/~=(_:_:)-3690"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"symbolKind":"op","extendedModule":"Auth0","externalID":"s:5Auth012WebAuthErrorV2teoiySbAC_ACtFZ","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"roleHeading":"Operator","role":"symbol","title":"~=(_:_:)","modules":[{"name":"Auth0"}]},"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"WebAuthError"},{"text":" values in a switch statement.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-3690":{"abstract":[{"type":"text","text":"Matches "},{"code":"WebAuthError","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","title":"~=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/~=(_:_:)-3690"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","metadata":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","title":"~=(_:_:)","extendedModule":"Auth0","externalID":"s:5Auth012WebAuthErrorV2teoiySbAC_ACtFZ","symbolKind":"op","modules":[{"name":"Auth0"}],"roleHeading":"Operator"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"WebAuthError"},{"type":"text","text":" values in a switch statement."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-3690":{"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"WebAuthError"},{"text":" values in a switch statement.","type":"text"}],"url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","title":"~=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/~=(_:_:)-6ibkd.json b/docs/data/documentation/auth0/webautherror/~=(_:_:)-6ibkd.json index 32671efc..72c5d14d 100644 --- a/docs/data/documentation/auth0/webautherror/~=(_:_:)-6ibkd.json +++ b/docs/data/documentation/auth0/webautherror/~=(_:_:)-6ibkd.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"externalID":"s:5Auth012WebAuthErrorV2teoiySbAC_s0D0_ptFZ","title":"~=(_:_:)","role":"symbol","roleHeading":"Operator","symbolKind":"op"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"lhs","kind":"internalParam"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"languages":["swift"]}]}],"abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" values in a switch statement.","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-6ibkd":{"abstract":[{"type":"text","text":"Matches "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","title":"~=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"externalID":"s:5Auth012WebAuthErrorV2teoiySbAC_s0D0_ptFZ","role":"symbol","roleHeading":"Operator","modules":[{"name":"Auth0"}],"symbolKind":"op","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"extendedModule":"Auth0","title":"~=(_:_:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd"]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" values in a switch statement.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-6ibkd":{"url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":", "},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" values in a switch statement."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","title":"~=(_:_:)","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthprovider.json b/docs/data/documentation/auth0/webauthprovider.json index 168782c2..3f6d323e 100644 --- a/docs/data/documentation/auth0/webauthprovider.json +++ b/docs/data/documentation/auth0/webauthprovider.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/webauthprovider"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"],"title":"Related Documentation"}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"WebAuthProvider","kind":"identifier"}],"role":"symbol","title":"WebAuthProvider","navigatorTitle":[{"text":"WebAuthProvider","kind":"identifier"}],"roleHeading":"Type Alias","externalID":"s:5Auth015WebAuthProvidera","symbolKind":"typealias"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"WebAuthProvider","kind":"identifier"},{"kind":"text","text":" = ("},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"url","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"attribute","text":"@escaping"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:5Auth023WebAuthProviderCallbacka","text":"WebAuthProviderCallback","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback"},{"text":") -> ","kind":"text"},{"text":"WebAuthUserAgent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016WebAuthUserAgentP"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"text":" to perform a web-based operation.","type":"text"},{"type":"text","text":" "},{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"type":"text","text":" opens the URL in an external user agent and then invokes the callback when done."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"navigatorTitle":[{"text":"WebAuthProvider","kind":"identifier"}],"abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"text":" to perform a web-based operation.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","type":"reference","isActive":true},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"title":"WebAuthUserAgent","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"abstract":[{"type":"text","text":"Callback invoked by the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"text":" when the web-based operation concludes.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthProviderCallback"}],"url":"\/documentation\/auth0\/webauthprovidercallback","navigatorTitle":[{"text":"WebAuthProviderCallback","kind":"identifier"}],"title":"WebAuthProviderCallback","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","role":"symbol"},"https://github.com/auth0/Auth0.swift/blob/master/Auth0/SafariProvider.swift":{"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","titleInlineContent":[{"type":"text","text":"Example"}],"url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","title":"Example","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"title":"WebAuthProvider","roleHeading":"Type Alias","navigatorTitle":[{"text":"WebAuthProvider","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"WebAuthProvider","kind":"identifier"}],"externalID":"s:5Auth015WebAuthProvidera","role":"symbol","symbolKind":"typealias","modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"seeAlsoSections":[{"identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"],"title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthprovider"]}],"abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"text":" to perform a web-based operation.","type":"text"},{"text":" ","type":"text"},{"text":"The ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},{"type":"text","text":" opens the URL in an external user agent and then invokes the callback when done."}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"WebAuthProvider","kind":"identifier"},{"text":" = (","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"url"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":", ","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"callback"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"kind":"text","text":" "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","text":"WebAuthProviderCallback","preciseIdentifier":"s:5Auth023WebAuthProviderCallbacka"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","text":"WebAuthUserAgent","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016WebAuthUserAgentP"}],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"WebAuthProviderCallback","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthProviderCallback","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthprovidercallback","title":"WebAuthProviderCallback","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","abstract":[{"type":"text","text":"Callback invoked by the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"text":" when the web-based operation concludes.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"https://github.com/auth0/Auth0.swift/blob/master/Auth0/SafariProvider.swift":{"titleInlineContent":[{"type":"text","text":"Example"}],"title":"Example","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","type":"link","url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthProvider","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"url":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","abstract":[{"text":"Thunk that returns a function that creates and returns a ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" to perform a web-based operation."},{"text":" ","type":"text"},{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" opens the URL in an external user agent and then invokes the callback when done."}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthUserAgent"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthprovidercallback.json b/docs/data/documentation/auth0/webauthprovidercallback.json index 4000a4d4..86081a25 100644 --- a/docs/data/documentation/auth0/webauthprovidercallback.json +++ b/docs/data/documentation/auth0/webauthprovidercallback.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Callback invoked by the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},{"type":"text","text":" when the web-based operation concludes."}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthProviderCallback"},{"text":" = (","kind":"text"},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"}],"platforms":["iOS"],"languages":["swift"]}]}],"metadata":{"title":"WebAuthProviderCallback","navigatorTitle":[{"kind":"identifier","text":"WebAuthProviderCallback"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthProviderCallback","kind":"identifier"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth023WebAuthProviderCallbacka","role":"symbol","roleHeading":"Type Alias","symbolKind":"typealias"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthprovidercallback"]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"title":"WebAuthUserAgent","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"url":"\/documentation\/auth0\/webauthresult","role":"symbol","title":"WebAuthResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthResult"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"abstract":[{"type":"text","text":"Callback invoked by the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"text":" when the web-based operation concludes.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthProviderCallback"}],"url":"\/documentation\/auth0\/webauthprovidercallback","navigatorTitle":[{"text":"WebAuthProviderCallback","kind":"identifier"}],"title":"WebAuthProviderCallback","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","role":"symbol"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"roleHeading":"Type Alias","externalID":"s:5Auth023WebAuthProviderCallbacka","modules":[{"name":"Auth0"}],"symbolKind":"typealias","role":"symbol","title":"WebAuthProviderCallback","navigatorTitle":[{"kind":"identifier","text":"WebAuthProviderCallback"}],"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthProviderCallback"}]},"sections":[],"abstract":[{"type":"text","text":"Callback invoked by the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" when the web-based operation concludes.","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthProviderCallback"},{"text":" = (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/webauthprovidercallback"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthUserAgent"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"text":"WebAuthProviderCallback","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthProviderCallback","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthprovidercallback","title":"WebAuthProviderCallback","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","abstract":[{"type":"text","text":"Callback invoked by the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"text":" when the web-based operation concludes.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthresult.json b/docs/data/documentation/auth0/webauthresult.json index b91d2991..c54e316f 100644 --- a/docs/data/documentation/auth0/webauthresult.json +++ b/docs/data/documentation/auth0/webauthresult.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"},"metadata":{"role":"symbol","externalID":"s:5Auth013WebAuthResulta","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"title":"WebAuthResult","roleHeading":"Type Alias","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"symbolKind":"typealias","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Web Auth operations."}],"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"},{"text":"<","kind":"text"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":"> = "},{"text":"Result","kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta1Txmfp","text":"T"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/webauthresult"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthError"}],"navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"url":"\/documentation\/auth0\/webautherror","title":"WebAuthError","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"url":"\/documentation\/auth0\/webauthresult","role":"symbol","title":"WebAuthResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthResult"}],"type":"topic"}}} \ No newline at end of file +{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"symbolKind":"typealias","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"modules":[{"name":"Auth0"}],"roleHeading":"Type Alias","title":"WebAuthResult","externalID":"s:5Auth013WebAuthResulta"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"},{"text":"<","kind":"text"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":"> = "},{"text":"Result","kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO"},{"kind":"text","text":"<"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta1Txmfp"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"}],"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/webauthresult"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"title":"WebAuthError","type":"topic","abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthuseragent.json b/docs/data/documentation/auth0/webauthuseragent.json index 81ec0186..d65351d2 100644 --- a/docs/data/documentation/auth0/webauthuseragent.json +++ b/docs/data/documentation/auth0/webauthuseragent.json @@ -1 +1 @@ -{"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"]}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"WebAuthUserAgent","symbolKind":"protocol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"externalID":"s:5Auth016WebAuthUserAgentP","roleHeading":"Protocol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()"],"title":"Instance Methods"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","interfaceLanguage":"swift"},"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthuseragent"]}],"references":{"https://github.com/auth0/Auth0.swift/blob/master/Auth0/SafariProvider.swift":{"type":"link","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","title":"Example","url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","titleInlineContent":[{"type":"text","text":"Example"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"title":"WebAuthUserAgent","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/finish(with:)":{"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","type":"topic","role":"symbol","url":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","title":"finish(with:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"finish"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">)"}],"kind":"symbol","abstract":[{"type":"text","text":"Tears down the external user agent after the web-based operation completed, if needed."},{"type":"text","text":" "},{"type":"text","text":"Auth0.swift will call this method after the callback URL was received and processed, or after the user"},{"text":" ","type":"text"},{"type":"text","text":"cancelled the operation, or after any other error occurred."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/start()":{"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","type":"topic","role":"symbol","url":"\/documentation\/auth0\/webauthuseragent\/start()","title":"start()","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"kind":"text","text":"()"}],"kind":"symbol","abstract":[{"type":"text","text":"Starts the external user agent."}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthuseragent"]}],"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"platforms":["iOS"],"languages":["swift"]}]}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"symbolKind":"protocol","roleHeading":"Protocol","navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"role":"symbol","externalID":"s:5Auth016WebAuthUserAgentP","modules":[{"name":"Auth0"}],"title":"WebAuthUserAgent"},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"seeAlsoSections":[{"identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"],"title":"Related Documentation"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},"references":{"https://github.com/auth0/Auth0.swift/blob/master/Auth0/SafariProvider.swift":{"titleInlineContent":[{"type":"text","text":"Example"}],"url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","type":"link","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","title":"Example"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthUserAgent"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/finish(with:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","url":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"finish"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">)","kind":"text"}],"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Tears down the external user agent after the web-based operation completed, if needed."},{"type":"text","text":" "},{"type":"text","text":"Auth0.swift will call this method after the callback URL was received and processed, or after the user"},{"type":"text","text":" "},{"type":"text","text":"cancelled the operation, or after any other error occurred."}],"required":true,"title":"finish(with:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/start()":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","title":"start()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"kind":"text","text":"()"}],"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Starts the external user agent."}],"required":true,"url":"\/documentation\/auth0\/webauthuseragent\/start()"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthuseragent/finish(with:).json b/docs/data/documentation/auth0/webauthuseragent/finish(with:).json index 9d84efc3..0fd6153a 100644 --- a/docs/data/documentation/auth0/webauthuseragent/finish(with:).json +++ b/docs/data/documentation/auth0/webauthuseragent/finish(with:).json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"finish","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"result","kind":"internalParam"},{"kind":"text","text":": "},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">)","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The outcome of the web-based operation, containing either an empty success case or an"},{"text":" ","type":"text"},{"type":"text","text":"error."}],"type":"paragraph"}],"name":"result"}],"kind":"parameters"}],"variants":[{"paths":["\/documentation\/auth0\/webauthuseragent\/finish(with:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth016WebAuthUserAgentP6finish4withys6ResultOyytAA0bC5ErrorVG_tF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"finish","kind":"identifier"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">)","kind":"text"}],"role":"symbol","title":"finish(with:)","required":true,"symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)"},"abstract":[{"text":"Tears down the external user agent after the web-based operation completed, if needed.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Auth0.swift will call this method after the callback URL was received and processed, or after the user"},{"text":" ","type":"text"},{"type":"text","text":"cancelled the operation, or after any other error occurred."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"kind":"symbol","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"url":"\/documentation\/auth0\/webauthresult","role":"symbol","title":"WebAuthResult","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthResult"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"title":"WebAuthUserAgent","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/finish(with:)":{"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","type":"topic","role":"symbol","url":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","title":"finish(with:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"finish"},{"kind":"text","text":"("},{"text":"with","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">)"}],"kind":"symbol","abstract":[{"type":"text","text":"Tears down the external user agent after the web-based operation completed, if needed."},{"type":"text","text":" "},{"type":"text","text":"Auth0.swift will call this method after the callback URL was received and processed, or after the user"},{"text":" ","type":"text"},{"type":"text","text":"cancelled the operation, or after any other error occurred."}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]]},"variants":[{"paths":["\/documentation\/auth0\/webauthuseragent\/finish(with:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","metadata":{"required":true,"roleHeading":"Instance Method","title":"finish(with:)","modules":[{"name":"Auth0"}],"externalID":"s:5Auth016WebAuthUserAgentP6finish4withys6ResultOyytAA0bC5ErrorVG_tF","symbolKind":"method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"finish","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">)","kind":"text"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Tears down the external user agent after the web-based operation completed, if needed."},{"type":"text","text":" "},{"type":"text","text":"Auth0.swift will call this method after the callback URL was received and processed, or after the user"},{"text":" ","type":"text"},{"type":"text","text":"cancelled the operation, or after any other error occurred."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"finish"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"result","kind":"internalParam"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","kind":"typeIdentifier","text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":">)","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"result","content":[{"type":"paragraph","inlineContent":[{"text":"The outcome of the web-based operation, containing either an empty success case or an","type":"text"},{"type":"text","text":" "},{"type":"text","text":"error."}]}]}],"kind":"parameters"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}],"kind":"symbol","title":"WebAuthResult","url":"\/documentation\/auth0\/webauthresult"},"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthUserAgent"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/finish(with:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","url":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"finish"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">)","kind":"text"}],"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Tears down the external user agent after the web-based operation completed, if needed."},{"type":"text","text":" "},{"type":"text","text":"Auth0.swift will call this method after the callback URL was received and processed, or after the user"},{"type":"text","text":" "},{"type":"text","text":"cancelled the operation, or after any other error occurred."}],"required":true,"title":"finish(with:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthuseragent/start().json b/docs/data/documentation/auth0/webauthuseragent/start().json index 22df660b..17505abf 100644 --- a/docs/data/documentation/auth0/webauthuseragent/start().json +++ b/docs/data/documentation/auth0/webauthuseragent/start().json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Starts the external user agent."}],"metadata":{"title":"start()","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth016WebAuthUserAgentP5startyyF","required":true,"symbolKind":"method","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"text":"()","kind":"text"}]},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]]},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webauthuseragent\/start()"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"()","kind":"text"}],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/start()":{"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","type":"topic","role":"symbol","url":"\/documentation\/auth0\/webauthuseragent\/start()","title":"start()","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"start","kind":"identifier"},{"kind":"text","text":"()"}],"kind":"symbol","abstract":[{"type":"text","text":"Starts the external user agent."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"title":"WebAuthUserAgent","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","type":"topic","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"()","kind":"text"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/webauthuseragent\/start()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth016WebAuthUserAgentP5startyyF","title":"start()","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"kind":"text","text":"()"}],"role":"symbol","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"required":true},"abstract":[{"text":"Starts the external user agent.","type":"text"}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"role":"collection"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/start()":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","title":"start()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"start"},{"kind":"text","text":"()"}],"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Starts the external user agent."}],"required":true,"url":"\/documentation\/auth0\/webauthuseragent\/start()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"WebAuthUserAgent"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/documentation/auth0/webauth/authorizeurl(_:)/index.html b/docs/documentation/auth0/webauth/authorizeurl(_:)/index.html new file mode 100644 index 00000000..025353b0 --- /dev/null +++ b/docs/documentation/auth0/webauth/authorizeurl(_:)/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/webautherror/transactionactivealready/index.html b/docs/documentation/auth0/webautherror/transactionactivealready/index.html new file mode 100644 index 00000000..025353b0 --- /dev/null +++ b/docs/documentation/auth0/webautherror/transactionactivealready/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/index/availability.index b/docs/index/availability.index index 3ccb3b52ca57ff43d747ae2e9d05b0390a84fe09..61463ff87cb6837cf07b5c1895b4f5ae59d5f074 100644 GIT binary patch delta 57 zcmaFH`iyk}lb($1C4K=lB_N@%z0mD4zm0&co&6FIPcLtvkf0Du60A&Ld$JzW4gl;f B5IO(= delta 57 zcmaFH`iyk}lb)K=C4K=JSsn2LSG9 B5IO(= diff --git a/docs/index/data.mdb b/docs/index/data.mdb index 41c6693375b7eafee3e4e8da747a14134842d31d..a426a0eb2ac4f9159abdec8316eeb3a3f7a0a331 100755 GIT binary patch delta 26352 zcmeHv3wRV&wr+NH5|WUF5JJd1olbYB)9FW5S9Nt&=LLv>h!7BwK@|E)LZ0M7LPUa! z4ugQeFf3HSz@P%6B7?{vZ;@dTnaJ>Y87?An(1Q%}a2$t02JhPaN+)pcch5O<&-w2C z;QK;X?X~vWuiAUBwf?pDym?9U<|S?2wU7MlHy`YKcwPsa+f}}{ysdnAd20FjvTbE^ z%0`uCl$|TxQrcEJvh-HTk&>k)6H2rtmy7oow-=8pPAa}&-(a6*A8fxScgkKlSw1gq zmKr3B^n>k~ZK=&`)7!omcZ*BJCq$ii(|W|Z+&bB+wtgq<66Ol5aEsr;xAPKz+p^p8 zyrrze5^XucE$1e2Iou_73){>NWn>21?W(_E9+G{z(;MN^Jxl``6N z#rT=AQn}aox^aoI!kA&)pUW7pH1JffUmSW`Hmu%u93 z7+?6kZntiOZjr88H$^v0XV9hSZWUZ8I99N|V0FR#f|`N}1tkUQg7|{Zw4K@o+6L_; z?O<(%Qm0MQ-q4)W9MLSzJ(asvvr02hQ>kHdD>RZuskx|b%k5I{RL3Yg)eE4BFatV9 z=B~=0mtUD*kuT*d^JDU-rQtekQRkf)$=1x^!!Ty_izLM&wEC@qu4wD%p*ym3cAj8S^1?R?gv^E#?*G z6a9`W=a|#-+~(2d;Ymy5m2nXXLWeoa9BIC6I%(RC-MqoH$kc3_5Ea*FifLrlFw^Lq znka+mcxH;}mhpmd_@HCPX<4I<8{-p=W8%9ED-5aelMTE2W*N>FP3-%6(V4gzMRVh% zxSXPku_yIQV(061u~%Xw{o65D3P;9lEWFTXaAA9&OSa*(Y%0ud1xo=O++pIpMXpXH^&dJlKFICS{pX?u*lbE|PD=|YFkQ6yZ zy*q8Fdi%g16gu_ktVH$q`KR*@s{Q$|=Npn1sHPklELkb_vX>mHelI)c{E{AO% zELJJfGUg)P9HQGe*(O=t4yT2i3yX)5K^av@?O6Vn+fwplqw;<($0i z@JJ5+F{r(t3`(CIMwVsX>2M2fkHyAK0#2zI09)@TQP~rbC)7T{<8|;N&$(=@;}Il4 z(r_|RI{}{@!D2-0e22`ttk{N!ks$g8B{Je+_|&M7VLxV2j3W`Sq>iLU;X}kw=on5k zFmD7&2K@+9lvsg@9yyS$0uGEIX4qm@Btqv1l9DhMsX~A_mJ%O~dI*#5hyJX>2-8N9 zD9}Dna-hD33``h}l)(Y!(J-@wDT2305<}F3m_7vhk0cgIw0Wy$`gfAZ;`k0ow>bm;Yx^j5hqOb_fjgGn|hl_ra^#55NM@^&0;hyd3 zH8j(OHd{l@a1_~Mh5o$40)0o3#Ej7Bu&mpS-;M+SlkZ0^1N`X$EZ8%Oq$do+_h5ev zgHJ~h1H33Gl9*;YJSHdv_{S)si5iMb#qha+k{4SQDNy?$NzEBT%L|T-#pbcNc#rII z+pLsO29H@4Je+(G`@9_An{9!fD)%)MY@H=0PQP|1?V?ez#wrz}hEV$2&HzhcOf6gIFtgySk>`mjKL8Q!fRT6m{K zkq3Jxk{H-oP2v-5$YBm}*eFMVvBgEe- zG>U=II;6B3fHY#8-)bbW&@i41j4r^`h(hRSB<4PzI=83MY=jraBg@tCWB?o)kKK~n zOcFqRn50Chky!`Vn+OljJWK}W~u_FVo1L56AF@NVoVu?yYw)^0z*~AL*kCJr8h*OxpOnH=;qxvJU4wgQO zwWW{2iP4|tA03^9NlhjoPa?ZCiKIpK!vs6br0?-_ND{m}376kQOcX2=#YxQxiG zC{RN1TS|l>Kf_K_{0yZeV7eESKf`gMk7oE}5)lW}3EX=_nO=h%Wo2Jv3an@G5xiI8 zycVx4T3t>`7#wJFUw@O&{EQSau>@+}WKcpZ(hCCgSpP_EolIhe=&IcI!s-4hhql|w zYL0D{`(T#pU}Jc%OT?X2V7;t`67mDG`h;Y~#+ifjILe=RZZgp%Dv-G)$gS`b*vCjL zPQ7_vY&L^*4fK7C6sl_L-7PgOO@ZkWs*Saso$YKQ$kzs|J8;>r_RMac-QcN*uE$V7 z1g#Cc`WP{!Rk>Zk`pOQ6C<`*n%U;h<@Q=rEi@l9i4w5anZ@b+VT%J6(TVR|*29Y1( zfJ!kSj(63|m48RpN;oGgQqt*TFqiBVt&(7MuueDoH+Yfe`T@o{@#n9=X;1_C4w=0{ zZVMJ7TUf6Z$LKq_K82)pTt|9+kZzS^o5)LUm&YqoLNHzQSa_?WRs^m zFG1JiB#m5xA$moc;v#AjW4t6a9Unrq3TR@L(`#ECU%^8qib3Qn$aaxI%!LSeTUMl| z|4SIR;NsmbRB|kCS^N?fd$7E7u&fL-ec>xM&fVDRXgG^GX27{8P(7lLp$_1jZrS4D z-5%cYIV4QQ%x7r-4k)i|tZkk7KasUA$Q%3>JhJGJtgOWH((mz$2&P+Q4-SCK?ZVFd z2*#nT^gZEZ&dTFvic7K}?uMr+`Ta1m$jY)qbXak_6yJk)DS3MsS#XFFZxtLCo7eFh z_>z*hg^{hi+v&nj#p$(*Z$bZQNPaDh%yKqtqtj~RIB^3Eq2ynOlbtTqov}q8tF#Vg zQgUZF+2#>hr^{h=dD%6vj*?e}ku6TEWDzV5uY+?eflsFqGkF|{gN#V0n@g~Fdgxf- za3EJFETcaU!vP11{4{)6u!C7Q&)Zy_Q-JG~OAUEW{Q2BB2{Qj0&diE#)PY$}w1_+L zd)ntDE#v}NUF2%|4`F;gRpC-MO1th`v2b&E4&T!M6wWN-Xu2fMDvR=i@Cjvp3;scu zw{MXvxW9C37cmJ!_!N)Zy9D12$-hexBp{Uxq{VZb+Vk( zDtq0ZK{o0xBp)8~V*iBC5bSN%%6i>yx7BkJo9s6WkSlxJs1#KL+;E-I-6!;~Q$!qZ8bR6hzs|42p z0X-QG56|L%dmz6Og-{(OR7UtR0o6z*hv8FPB@!-SQFrQI{Sz$I@)B*R+IcJsfmC5% zgxh^R*H;e7#03vjVX-fT)xD<;w~PvTC!FkHSwRqa3-9Jn!vQL!AN+|5p*nN0?iQOY zpq(djlE)%L-V7A7I$TH(J8;|#GJ*_+mu6rKzYDH|U(!5OWekbrETY$Hvsv6WaU=Av zCOoRZRL@j2wK!o;H5o~4@KH5Zq$(^IhjZN_*?5o3%^rb-8q%6hjh>)T&g!*U(WrCF zF4hcdYEYHXL%*?9eHu&pz^Ga>9<7NrwP>hPg*TWD=eQSbJd0cMx*j5sI2Bj$Gw@X{ zwnGobI;?qDSZjOOF7P-dpXfmjvm9VCl6`ic06|r`ADpctB1-n@%Dd`GBJR^e8c>&8 zI+4WnY4kL;)HL6rIq$D0Vr)>o@u|ujNDah7{JL^-NLRLCU1-w`aQ!*dRsG`piZZ0m zBxR_mQH?mITO;nN2OHraG6B&x;!2zl!`;_C&O=LI;D8`0nG6oy|Z|J_UaH$y^*RA~afrTwZiVe>6Fikkg zTvb=qtSi(8YKbIT%c;~h*3TlQP@aIYJZTozX)h%NSF>(yISww*!m%+!NK=NNwGs!_ zlcQmOE74=tpst)4%LPhIqg^e;^-_7Ix?b?2Pepn5$J z4*ZI+Ob#0rKVsiuJ{=UIcG)4F|>&U7)Z#@itlCUIP zwch+BF@!!ZzxJ%CcY7df4l!YOP?b5+r!of@ssvbe9SJw)5FvJOpr~%8I28;}VOMQ@ zij?3c<1<>QDhzRR$>30zgz2^Lz+A$I2C7@PO@b|R2^$;Ksw4gLMC!l^8m8wm0qwSb zK)a1d4^)Vu{8{iy2PujTXtV)6wxh}&5$)rm|1lAEW|Zpd^5N=Zi z@=@idRcyIdpIUya>_XWI!_l$^{noOT=-+mhjVv>jtt?6@yII<4I9EC$f0gDi`n#8- z$NNm-F8vdw!%8<7>Ptrz4mKnil1p!voG&?Aayx%p$;&0rl*}mU7++#9xl#1JYLZ@6 z5?69ceN%H;|6TFv;)BJTi=hl$zxoQoH1olC`7I=bjq)+d_R-(R$n3{Drngo406zVNB6v+fdsi z!+QO4mEN{lm25j#bW=Pp9u>EVFN@EJ*VJ>1HmYZc&*zU9?V?kq5_jt2#P6)_h3fp% z)`Ql~=(%r4&*Lbo#hPJdtVcDMgcIn+?^rL?$Fr_1fAY;tl$dQT(E`na%BZN z?xyw{dqg`_dx~AE-p_7im$GfFUOSByjh780(b1U3Mz9ynUFQAjT^)v<=1y~>-fphY zY}2UBapvz#r%eYI`Kjt;t!KX!^l;sIb9s)_B6oNZcb{>uI%yIiP<}{gsd}}b(!&*$200Olo?&=6VorJ%}q;9+dRlJ zXj`h3dTgM3;FXm1DIMceei*QDK+b@-lP4!@Ye_4T)Jd!RrSw~ncqL&` zf+b;Z{HXZzeVu)8#jT1P9oH4RD7Gy2RLraxeazuL?miiPx}rx$UyE81^+c3D>TKka zNJHd#1^u9dJDWogZElwLif&dK7`EeiA@f<%H+?`@5_-E(QAeYKbFxWL{wzt$qV{({ zRLC@Ht?{(6%~1rV-XeoWMTH4)+9V0BF}EagEVW33b?{p?&E8oyw?LJ(V7k}hVZDOW z#W`4x5GdPDQke(>XLq2d^d~G>3s;}TZD!hhl9fR1N)7(e+_zy}22%*z=984{fA~^p zdVGXi5^MtJMhB6bqv-~CdOmJPNx1Ar-NN?*_&9?>pXqZX15D51mNYGsNhW`%((>TU zb0mfQjjqv;!NyER1bY^vg2*g{F zF)6T}=G^jgk^-}SP9&I@&BOt-08MFXZ4QPZ*-R-+T0m4$)W|G{%mt(z_97jgUx03z zX*o;Nvh&sQS*Keqp7WlThO={$OyRo0?EoekMF@gpcbzzqq7202TX@2mCS=MZxQGVG={|x1xM#aX#*cZ{YMQv3#e7=NK!ly5iOvP!ePE|fr1CK2w z=~2|SK}+gIBEz<&B!irSPnM!eb_$bi@SvKJLA8wJBz%VN!R`Dre|?@>MiR(L|MLgS zNO1zy@`5VE3Ey@OA8VLcIChRnf@Te)gUBzLRIo2c6{mAKZc)d>nC5+nLwadBdcKaK zn9=x08*_~A^c7(`7)`@`gbH7gp{)h9^flGr`6g?hJ^w4y4n_oc5=P2`WWM=k7th|MD ze;?9Dz;#MXdv{Ue~Hm}F&a=Ce$ zejmI^vrKy#^@q<)SeN%-MnCULGxpz77Aq9@3d(*T87)xzulTJ${t8w#hGQ)7@+(9g z^`4L7cm+SZP74#cay3cOY!55Wfsm3Dp*7aQOEjIwKU$gXkjLXpu3wGAKuyqLf%I*# zY&Drew!)RwBrRbprUv!=t$ua)#Wgq|O07&E7`X=B)zrp|kf84xTuq*|G6}Ikz3nY< zlrvh$7V*P9y9S473o-^f!OObQ;`E44&dbwu8(g(AER?S$1yOI}dlB?oi%aUNwInBP zb67qPZ}GTXUfC&dF7U3!MNsi7+6bFq*;{DeZbHtW<+6#^RtMFulKwFCRa}HOBV*zl z$Pt=aZ%`I3jFp%eDF2BW81*_5ImAwI@n$>G#CVM|XrQhWm&=izXnkzzBm?1@PBb8I z%S;kh@Kc#F!BcizbB*gz|D0$?c~jOQ;wG*`CVepy)~-W!G_n{8Ym4!_Z=+9<>q#^qFmK?V@lbY?Je+yPKRd8>@eJ zM|w>iUsJ<=bVquvduH7X@x$))!2y)k(Iz+>ghL@hXj^V_)K>{j`;gGuv#Nr_QD5Wy zEiC>u+Nt4wH-F6<8>S2HnjNqQ$q#n>-9mC(XR^Yqw%?%Kkk8ehu~ib=>+0VP)g(Sp z!cMw387EgWpg9G$)W4U<)wt4z2kH=iY=a(p#N)F-b;6o>#C*J zrdEIDnZ$U>X7L9AQ>Gbwrb9pu^5Yg#S*i?EK8m)t>iR#!GV+>7B;N`B!EvN*%* zWCis5yiNvn{5(VswY9CLrpaS_4hbQLyp#Ge(WBxPCHdJ256j>X-4>hGB|2PQu}3nf@S7&QrH*x|*ExB?nCptek6o|4}Vo=*SnoEPXYCwRTLaGyqmi(lpd-=b39StnUI&JV1RyLg?(mlzuTWoE! zSOLs$q7#my%YJgG291syxzfeKv^O!#CEQ`?Z&7tC*Wz)SVHsxcpb&Gf>@72<&vXbB zLk__g{*0|NDs7&caEGiv9pSJ_PXk4Yd)BkIvfffNz3`57L2CCpW@~AB2i>($vGEJC zh;nngRTGxMg&3B@=|T^zEQO~B_^mC?ZW~34dlp<%HB+i_slw7-7+zwra!!w%bBCwv z{er67-CoI(7s?Ro%2sPl8zdb_+9Iv$By8s)obn^*WtS$?M^* zl+d$!&ROl1)t(G6zeUoxbR>tsVu#Hm$q3>g4#ZMI&wO&t?8cdHnD!Prb~nMMx6rqG z6t2HTrjqk8?rrjL`m148=wV92p0~*$?q9>nB8RSH*5&jF9tckl*WrA6KC1gs?~q@S zzrfYixCCs4-@Jof>G$DZ@F)FPSk@lODHLr*uI=#HR;=Yf_%*&IP%9&-Lrnwn12Mec z_g(Tch8zUXZxG#}S}ROjidN*G;H}?azFY9u-;k-)qMf)My`Cpv&35u4VZitv%3cSL zzlYOfLs$*`gV|Km-riXIEi9&7n_&;-3U}xGxf(@pjm`UO_?B|5hU^_=P}crCWOXaK zRQ<&Ecy?f`zr2I5j-Sz5@3;+bAsMl$&rurr3I0moR)OYyvJY|FuinSE*I?jI{MiKe z?<7+*(a!2M#@=e)HM;>#RCsqjuAI~e@A(mUq}obr^&$8c#VB4zzHw_Y(&$aF{uagV z1rPn%0>An#cHb-T`ERivYvHdn@f2uw;m_u!6Y-$Q<$?bB=h1$58KfCD8020x3)Za)J3_hR0- zy(AZP&!oMWw`?zYn7jka_ma_M4}7r~b>4r08+*w^i0lsEhe*j*n6?l3mh2;wR_-Um zJ64p;DRGyKE)hzyN+L1J_GIzy;tj=%ikpk46b~yl6sHv5vR|+tvv0Srw$HcM*eBS} z$w%a^@+x_rTq#$`lB|?t=AYWI|_Yl+st)lgZUCV(<)6S)7QrJ#%abB z<59yL!zjazq9aAm6xoZu*Kg5}*GKCQ7tX~n*~_|By79U!-HC!x<}~x<#K^?6rcTrT zgbAj~gcy@DVViN5@#}cO_`P9${BFbK`1yv>hUoYd!_mH{i&htPEbKe2Xmnp~QFPyn z`mOrIam{+WzAlc@A1zFYd%kc?;o;c0!fCO`bhl#W=r+cfVoG!;`rIyfqR;k%ThX%$ z=0%$dvZBvvH$*MfWEDE)H5dX!xKjsmoKRr0PqsUu76&jVZm_Cc_FTTkV#o*TqVQk zN^=zrc=XN$8W9|lr+iZ2+#j*R*RGN>m~#zrjbJ!gyI)w>lO*ze_BwhrLW5OB8>)jx z|3(JJJ{o9z72Qm1aE4`a;k6&g(-@(3{f`U>l_zmTYW_xMrFSd;@evs6hi+7h%_T_U zeemPoh&cno_F6Bh2r}a1PM4K`8RJ!-MK9CZmgZ6~SKgj*wAPKP*fkF1rLAF4`KZpnS)TV#n zK)eBe{0A{V5WY#eeP}r9UlzBO3oF`<;VVvy;POhMP!OIjIyj!^9h@Y(GvUG8*shP^ zN&2(m{Wovp2TX3jwV#Nt<6PPLvM0)t%TAO&Us_grv1Ch0V+mVwt#}LW5QgIK?Yr&s z>?7^*_7n07d4ilKpO!kM$x@bd!M4FxiEIBAafdipED>*5_gfpSChHMlp-?7VL5N1; zZ&+4ap0HfvI=M0~f}78lu&2xm&B^A2rtzj2)7!==#?u{!`39w-tH@iFTy#|bj9#Zd zRk)~dXyFgK^}0*x<8^D(<8>p`_ZKu2TuU<)yqq>P?UZ)D)}XzH&`h(YL~};HRy|pr zq28Qt&p)ghuDX@CK5t~+W#ww+Xk~{sg*hcT-(|m^Jvlom`*7BrEOpkg z%!W*RW_0Gb6B#dORAz`7|Ne6r-KQ{uCop{HFQAGr#*X0Wio2by@Sm&*o~ww@Uc_xk zXyyiUl?gg7MU}+eV82tH!yR)=;)%RRtqWX8>QyH)&3#$&fhGC07AnUHc zQk2YBwRvE4E`l??(4zLFVAF`_8O)(aqt zBLQ&e<{8{kGZvH4{rDL*e62IM;dVnr{Yf`GG!~WZ5E#S+K%hQ_Mq68ryB22TGu6=? z=eBtL_)ni2kE2mn7(jgvsS*4OAU%CFh>CS1Jq57(9QI~7#Iss+SBNJePBI5ZxEI!w zLb{=y90bsUu#O6?UPN&o#!tzI{H!cM=d-&2HJKhrO+UsX!}S9E?hverWu!2OCho4# z%s1)GL#T%YVVP*yU5HIM;QJJ#eV<}CHq)1}JOq0RQNgPC2E$s|4;drl3PWQ;%Hlp6 zk)H>s?$IXnL}ZxeC*WH>qgnYE@)7r;$V^%Ij7C*4gxJJB6zI(l;9VnQfK4Vw&4i;j#0`rNAp~>vdm={L+8SNW z-8jtvrm`CPeT3Ahe?`@E49i5L2KNUOGc?|X^}(Z5RgRjbMqGIF@sm{)L5+ zkvjzTgm(Sy;NY2uV}q)wAKPIfYT?b_VYaJ0Q^r)Wkb4Bt?3~{-$+5!%t@nXFBTzMe z@(2#nIf2o{g|v&_a1Uzi9|(wDpmVewrWD{bOJ0LZ;RQK7)0-snyr zS!%DFSZ&3`T@`UI04=LzCR-PlijDEw*z ztoxX;BBDK{69FXzgA#}U{big}vB$6%EbwF}VnV&4A*R_3{p^e-E@q}^rKlArUytWZj?oEQib7c!yPnvhsJI7U*?MgAQ)RfOZz^SynC22F zDn&*NB}{^nGA4t(+Goygv_b7BI5S6; zGl|%9W6Kz0lB1=$vc9pZ-P6)oLkoq|WsDt(3CEFfe}^I_HmLfp2%L&I&cq}K4ZaoF z;wE~;(ER?!a%R-LsG53jZ9DvJA2arz-{QZ_Z*do|Mc&Ddf2P-BV3$;vvVfnQHd=iw z#$p;AwN3eh>2h?V=C-0D=5pL}#i_{kmaairrB_n2Qn%Swnrez*=s`xCZ~!fu!GUQJ zzG3y=qg1gWOHFV)9ir1C3KB;l&!Bsvd%x1c_j)F$dvEIAi{R&nm;^ZdA)-Wd_kqNZ zaG&h4-Gps1@W+ps^eAd+hV3kUgz1efQbg~K1U^2DzK$Co;j-h~KEgMRu#Ez8j$nbl zo#8Rq_B)2B`#?F)>EJe?jiSb6*xC=j{5^u;?_grsQXjsy!?dF)GO%vLQ6@Kv;;v!q zGu%ANq(r@eiQOx4OkC)YW%xoH3WD)1s-=)7;~`R9Mh8Nw9iJXJ#`H%QF+CXy&mCj3 z6V{^8;=tf_FMQeP$)xKWgF&aEbqi`f!QIJHipp|ubxMxC+hX+nCsRy37cP>3i!?n~+E=zz5tKa`;h%iq)C0i8dR z)a-DFjyv4(f%)#)Rn)GEhO9jN@=hvoQ3;0L-Dz3%j=B3M8B_xtb&Z}nPphslw1nI} zj_xkj)&FS#-GADsYV9_v;?Q0Rg}vR?rea#d?WxWS*tIKGk`iBZ8~%iX*X}fp0zqma zQ>eAu^hspe!t5P1Q-XnM35+}3l+pSvmtIk4IN5syo2A|Z3A&fjdmzDGm*xKeNRUng zKtsYL7biKL7~UYVhd}Xn#I)~$2mgPA2k_=?W*J!wr9Ux)(rNT%@LO=XSo{{ePTu0? zH$g2W9|$L7oRW*>c~-FT@4*^M4&T*X4%vza^Egi8-B;n0pBQsT8gAb4KJ}6Q$3*-< z4&`1f?<(I}-dSE#&X%W@N0eVI>nht>)>*cotf6dD+2Ar=SyI`d+#99mN{^IoEnQVQ zue7qXqEsqXmd2D`D>+rNzvS+4xK`PjXU|(yd`(GV@e0+j;_o}`XY7aUIjSx874|uH zw|%tzOs-&8B0}=Duvu^mIl>7%#8Sa0@_Q|f7Rhp%+rl}y6z(|t44c6o zF?TeYGt8$=HF(UV%lM2@GJb8?fOk(VR5lnU8ZPCP7*vKB!lS z73CDg38VY>gVfc=*Q<(=tX^&p3z?{JdRgTy<9l2&|5gV&{8O>(h6_u zF6fTxw(3^u=IGqIQ94$aidRsbFNp6@ZcrX6c)MUlL3_cpf(GUA0z*M^!42(M?IG=E z?NaS5?G!vtqtia0m#F<-b6QiW+OK(Cvj{<%$(q3$ttMXco%)peGv!`&q-ukDp}Ijm zQC*@|sbkbv@=xaP%J0m7KEErkCVzZ>nNrHn$&bvxr0P=bP_0(&%zH+4P}lJcUWgT; z+gmWVU|0cDuv7cIcA_>>dstJWF=#HSSE{F}b?P7TcjwQ|x8#3~H(5{=FF&Q+wKvzI6pgVKK&rsB#N{>@nh$%DTi z(hG>v`29!@O*IKG-f((&yrqa|DZxJlLs2AnIn=Bw?_QXL88i0YNq0@3-PY*b1JewO zlxnWlRy}=pxAc${r!c#%&GA7uB|buS%6OLFW|8pb97^a_?hI>#+tR)(Jcs1A;yHL$ zatRLSE->a{g?5J1Wh>9gcuHQfaMqnLHBT`pW5=C>t)6P@^xF4eX`UiopeOu$mpol; zn_0!a)lG?yz@3Q|T(~#k38y#Vb1M1QcS^2ptF-aW>wI0&XLeg_Tl*>k4z*%H$8^?K z&C{^nP_N5)`-a8i5k@(^_Oi%W4)_-S$Gb~%Zo0~g2&Q%mJ)jP*YpOF6=&1v z-rkg%o@hs7i^~<^yAuOCRf;GwmtK;U5*>D77VJ|g1}Z}rX7mS>ETm@Aj_Hj8h6k^{TkARtliUEC^XEI6wo#a`g%&Ua2rxkNtd+{-i*i9_vv7OE4*8T=%CEj4b5@S3N6d z!U4U)lJWjs+UviR1o8?MDSh~QN43zNNas;XpTG?uJ#HacT7)Gw6yX5v0Qwv~qkgu# zej|NOC$IXFVBUD_<^lrCim+7zH>=$-)&COBTAa<^A#kHe@erO_yR+*9ce2sRmJXa2 z>%huZm#aC}H~j{14za~W@A>I{QQ9?wVm!<>Dn_AWtH%XtsSsyUOpFbJ0u}TyvG0Pk z1kwW2Op4m>gU`PE(QJ@qR!o9jX2nF(`<67khpmEDOpg->(@w;1u=|pX6T9Sv(Y zidT$+D^|2L&pm+Gl+`y^dK!a8-VZZHMIpopiu5>dusiTjc<6q#*6#b!`a`FnC}tYN zZb*xp6+F5&)F-Hq4_gS{ik2cOa>x)LA->V$#Y+P!o9nARb)Xj&WwAlfBJ8F#tZb#I zkmH14Ol%R*!(>T-nxKjcr! z6@xm~hRN)G$x;H+{QsDU95OWRNcqb0N#z;k|HSB|j{it_(mydespCHqp7c+QPKwst z3r`AO4tp;=>0WqJ_+j^Z;Ym6E^XhmM{XgwVzZaf#FFfg9coL%E_rjAfBIy6U@FbX2 z&Twc*9_diby%&b`UlxXR@AwqnlXvg<)Vp#`meS3f(0oH7Nl(7y^s9(#aH*;v7k$vf3$2(*_^U5WvOK+OShKJD;-~& zQhKsvbICm=mXa&Qdx{qpk1x(C{;+6EQDaegk*w(b!cB#D7Agymx#zh@xl`RIq;APC z>810o9@j$GOqbeqLEI}Y7H5bi@f+uU=Mv|1XO8o{uubR`EW#yz3*X4w_$%B?+# z;$+-@$708HN0#Grb|YKOO6+BOk9~=Kx;@Q)%C_0I%+_I>Z5wB^C|O&EZK+abJ7+y+ zy+^sr+HGBI9dFIB?#!22&*Y!89JB1QbXyi%8Z9#{_;|0S@ zhINKThI+%DhEjvxkZibIaH`;7!M1{x1@jAn1(OTJg1my*f@Ats`UUz*{S>{VAFWjC zmg=f4aI@tyL$gzfql39Z+pm ztx(NVwJQCpi7G*rrp!^rs4ghqSFU0gu$3$~d`Sa#GGI=h-=x-#*d4Eajub>IA`_V~??4u)S~FW1FVjXj^J)wKXcb2i;@y z=8U!l^A;;CwsYBOwyV}N)@36OTRU?mTE9+Qm6&WjW|^J1!V;4>(~@K99(>BIAH2zY zD52W?Py&~bXFd`CzG-3nLeuDY$#g2NGwz}>C2n(gL$hnX5@aWdRzZ_T2E~G zpzZn#xy#fm_4D)#v%UIp`X%|2^88?%K22Ym`>pP@?x1d~E+uw_Zk{Su*{SPRT*{iQ z8>6%6yfRg)&a1kjU7CDKdq8_sxkdYa{vp*e?P>Ym_=l7$RjrwGwD)N9QuFc*`TKKb zWIZ&@5;IC0n`zKq8=e}Itok83`ZjV2jc^N=5m z@LdkKOLF=>Ud}NOnnsfmc@@YHv6EzXv{waNt&Ya3K#foIA;S*G)bim94_?ZkXEaI6 zqLh7c1JD?nXvSxF4clk|dwk=M_B;$_Ue)QqbY$-JXEt z;qQW}w~`T=GosjTH}CcM1%H5ZIqrl9Z^glxj_e>z36M0!9eByXpKm3isj8u+wyM77 zx{kWr>b=c%(@?C^-uqT!WYgfQTZv8KYw!me;MlEL%T#2GaPJtRgYL~_DCCbJ%Dmf= z=m~d{Wd)XXa-!Gk7b#;Dd~B1uV7FDC4qL{M;mMPcD0BCXRnm{jGf!On~Ed`8c&NT+ZS0xm_IZb8v2MJj#{# z$&IHCnP9{?VpZIR^pWuVIKsjG<4Bg;A1*9<1y%@hJRk5%V`-y(g~!53PHu+N4tXM6 z97p0{9-UPtuY`qC`<&hen2; zX2=9$(w8GWGDSF7fb;PIx6ki#QbuWCf$~s+hbItAY$DwlfBsk-e3$bFAx5h7nWfQSqg(w&vs6yB=kxWREkTklltOQMy zh#u^dh%-qj?`5 zx8um$kt4v`+ld`c)sqxhcssrx8xl?ML<15J-%hd=R=gKs))e9f?G%!mXTkeO*QEf< z@?Jp{oE|@A*kH#LY84RnYU~Oh3nt@Ek+D=a)gR&xDI?p>;r{ok}yvJ!mp#qpR zmDuv?J#~SG$fF5-(COiPT+ksHQN{{SqYT_X6+f9W4;ij7Akhe4B2iu2;Pcc5`Z^Yw zl9hobhpVvw#c*6kPQza0O(VIndL(#^@O?AZ)-a94GFbJFX?SC8!H#dAhVwk8l~`a~ z3tnBAhR>nF5(emMMVU{h5d}zhVDoAuN>Cm|KE1TVtCas-D;Z8yp?Ckm9V9nNi9A!^ zoKS}7y6I#H$)h?Z7k0Igl=v_|2OM+oV_!8L>&(J(ICeiGJe-+MGGa3E9+tHe5oWg& z1ygT_xj#bLz3n6!-)K_@UT^vl(dg4r&KVvi5B><%&$*o?D96id!!>l`rQ85f9Z-K8U5%or9LR)xFr^4$$#&*U!0(7K z8+24ApmgNB=Yx_X$OYY^)90m(^1k6opw-x6#a%cUaY(O)azD02FAMra;$Z0AL^-C# zUK5yWsPY#Y`Ouh0nyajFumN~cLF9q~zk~M)ob%fVJ<^#*-q+x+yn+mGq#?IM^5T&A{k-oA+{Zfiw>{f%>{UWfcKn?qO%@8!1+B+UJCNS&LU}?uJJx`!`W+k#)O0qQ~iVyTupbHOhV=iY<6V ziFXPf&K30RfG;R}dlcKr`_VY`hWW7F*(-&l)g6AlEWfU7f5{VNyPtfD=EQL>I6Fa#Zl00N= zCS8WYqcgyef;taMJq>H=&r~?#!77hM4YVkFB-YRKE+1OA@Ew)XfYpmXCwr&A?we>~ zR>W^hWbrMEFC#sy@j~VVJnkiJ73-p$}hpbyKuh5!H@7R<^&2; zU7kj6gSC{swRdvMFCaNTfNNP2I0Hz&0|NN-znFy2A)EPL2B!ifJ(KF>@R$tH3y>7V zwm$$}5G$k0W<+Yh*HMR3F~6f-qiRlpY7W=Juw4`%SuX`R-h^u?TI4B^Sb@(F3#tkn zWva`=74t#X&H960pAcl%z|;zSmL2dQN|9mkB)!`RZ&i@7|vCB7O~0(dUgFZq3ZJcy)3TBE@=^{s_-GH2JQ8shzF)tVb!bP zL8NC=2QJ(J&LiQBcX=eg-?I&NQ1&0NScL8N@IDUfb$P^O_>5Lk4nt8jWm0=IBIR;9 zIiE+MpWah2l4`Dba91@x`AAq_jb*;-RcD#!qic4cT`J%=>-GwEAT?O#8OW?5JX%L# zJ2M{U*N}0zF27lW-qP)-`+`0fi@GxCqYhGp9;L=UhQHL2vDws$jIbT3 zOHfU54nOxUzJhmeBf}?A=OiM4pQa?>3K#;Ai zm)4MAWg|&Mv$Nmu-r7h?(I5yL-EolDL<&jBz>cK`_5efr%_dTYHU%}J2lW}zP}+>| zv)^EjgFVe;6beNQW_Y!k#N*3ae~zfZ*MhSm%7Bg!ySQj_%)^eHZy~8@pnlhahHS4z z&9;)sB+8mbLn~}KC&h=KP91u>j5d-OANIyVR&}bks=2k&?`e$;S)WyXM;j@FLv4hM zsD~&M8@_GBQMzvqVI$l=WBai=#1?Pt8`SK`=nrAS*7v13BqlzuPaq4LvKS>i-cDT9 z4v&Sy?Zkvn5V6JM9et7+Fm(|T7+Jqh;UvmNM?0{*lZf%7`&y5()ZaH z9>CEr?^2Vf=i2i{UXDU>(b}edQIj^Qs}9ia>p9OZemI zH<^>-!-jfH=#|EGk#tD88z(H<&#}otu(E4tNGiK z(^IH7q2Q_P+VEu zHKkZ8PPTMt>P^bxxZ-lLae-JVw(3@xExIXUf>sih;#qZ^ z*lE1vJmK7L+^p$wZgwtnb~tA{$2nPNhEwJ|Crs8K6LtyRLf2y9YfYn2s6A+&A(RW# zv<4wXxWb<@oaT?JgZe}Kc77GVfM2S+)0AbdwDD=DhBXgkhHXo2OyyF)9s1DF(L>Lr zbfjDwQaR*g@~Gs~NsE$Flh!4Qi7ySFGWbG5cY-$Ibo}yoOZ?k$^W(DOb`7c@q#d*- zc697H#S4o03QqBP%z_v(=At|@tNSj(OO{V^dwgh-_;`muI3jB8^9Z8L&+e=Jdd|Y)Ikkvgzu>mR^_ATUFDCg*CCX;uDPO+Cg(M^QD&B`j!Y>If!Qn?t%I~0b3w%oD z_AEqYtp6!0xx5dV1W5fUf&kRD4eOR~!SNx(lPkUbfyKy%D?de3=-7vh9;Ph9E88NX zMmH9E{i4|?acDO!MeF@jus=$E40}&9v5@g7B1ET9N;V1dKf&?&?j&P`%a0NV z{P+`QD17)RJ}7ltTd54Tc@mmFVcMboF)a5nB~`$^r3)y*;V1D5PL31(Xx6&|lP3XCPMzt5stO}E(F)*Lh{c^qT+4jjD<%i=k#Yx791Xn zD{3cllHNkjIQ*j>ehWU+<16i6M3M({0e4Gv$D2q;sJZ|jn_WTj6bJEsG`wEG6v1OF zNDf?Hfh+f^6*y%MP&0%F(=SL~?r(c*!~ZaZ736~sj5@dwF_I|#7C75)PG_e^?H4-#*o9Ax#tXGUfW5J3NPA6U1O z5sH1tD28VNYpw^PBzxg;K=NKBkA>rAl)lT1qx2mXQM`u4TcB$d83XsOLKuAy-roja z(EE2R%n*2g70#VkkvInbXnU`Q9*sTAq(kYGIL^C~Tmr|R#MYKSiC^$5@Z~ma?G+^7 z0;<(y6bxI9GiuIi9Gq)5W)K{)GlQXiHI8|lgW=)VtBFeS5=wKh-ho5A{ZH7pIZt6+ z<0A*Y_bD^b1i9xalC0R-EAz=yXkz{PDKw;CgxB#W=|v>-_(wbUA`qT&LCzZN^bVwq z?xXLZo#von4Kd|C9}=biC(1m2w?F9MgI>Yqr3?;+tVLDy#Tt^6yp4)T^gpb58#Rrz zP}fP~Vf0$GkM^%cjro(cB%3@7Pp`!Xeir3i&?PcfIJXuZmd`D8J_#= z-fC!NiLwCC1$@3BdWsGorJKR-!jX7k9je;RQF1;fMrl}FblieK={8V3jg{s+jeg8C z(Bxt`xch069=i#7SV^wLSO>TG8X5zJS%pTK1J)w}#!Czu=r$%uX5r7pj16WLGx6E9FSp?c(tnA40n!eyx3aqKO_;R-7q^2^ zi(6=A^0#=Knrq&G$B_+tH;@e9>o>^M`J3vi#r+X_WCd;UG*k&KuOZ{QMg@3o!MUB%^BwvS$r^mUc<(tZ#V!hH_23*y!o_ z^$qlz%8DAc{+S!-?Ui$-TFjDkZ$=$hvl&0W^k3up zyJIuS&ZM~k13SX;ovtcwD$M#dJ}HgZ4`esjv9%qYli+b=SB{OaBLhFTr77M$eUrC=Mxd`7o3`qTCXYbDK^bg+7RM$Utqt|X-&R{0Xf(nnw5!nweTXec zok7oB9VBfm2qRhu4W{JR{*Xx$FP(s<7D0ZlHZB>(0>r+7;Wvgyr*L3=W5~rlf z6~jVXi6ScxWg?Lzj}LKCN#gwoe&)fuTk+-PAU_f%^tggSuh%OD1H3Z_$aA=cWzsPn zmd94LJH-r?jbwdzTmcEuSrNlAEO?(o+-@^G`y67rZ^8d~j?7B>42LL;$oRmq17W>K zw&BEI7d2T1`d<6c&Ov8@nmd`)+zG#u0VXiyKTm#vp_*5!$w6_tM}sdiT-GUu-8&FywXUdJ%8;!t*a;>nGsN7g6RPFk~m0MMDaW zJINSw9A4f@9!IZm>~9cf?v83Z^io>6HdoO3OL+V@Sj7c+hDt@-Cn2d8cYRHB>niw? zN^O8aFA=-^DV#=qrsnN0UH90bQVo)$#Xt8&=t6OF8lFcf@*TX1cbQM$(2+hD6o$Nv z!T@D2lYQh{_@3Tv1p6-h*$lIGky+#qux}SOM_seXQ zp1eWIU+ru3&e;ODBb&SiUG(Q!c>Wa(Nv*y?*gLnv+bXVwA-hrP_fSTEK81$eWYnPA zxy?=f5d^w-lZ)g_c>GmleGU8Q&u8%EtJsAPV9*|XA!p(CJ=kArgAVL3U(5O$T6>^t z51ExgeX=`5HQro&JhO;bSO&jXXs*!O7Q1W;TTb`U*xg zR3C5vDSOcbUL%8{d-02!v6tLIw!zlDWFkguJo~V^dbXvW`y6KP!-=KeN8A_;#cQ5C z4=eVOT6jn;&sy0-#&j(&?kx6V{wi0TRm>EhFM6+NchQETB}L6eGmAzQnTk@2zAgN` z@a@7E3Rf3CR9Ia&t?-olpnIEprF*_R=$`Br-Ffa<_eJSLX|J?NdQ6%l-6xHaY*M;( z&2`pw)K%-!yS9j9#4FAXPLp%DFk46vdiYZQBd(ECa_@CvW^1t{*0G13$J*FS_HFiR zyTN|ew#jy%Ez5Qq0i|iy80&6JrA4${GWVD}&7AqHX`Sg#(^X7Htu>mAXAH{>V+<*V z_X@__rzB_C6O&Kbb|x*i)h3OxU9xgXJFU&ui;0|dQ{uOl{g!EoODyS$(<~X54+no_ zUNyLDoq5_|zgcfi9emOBf@ya`hpF5&J0Z?=z?hn_)VMW%oH4;TF8-Ui-G>4x{LcJ@{MC7Sgvsv7WpX#? zOw75Oy%mA7wCqD!^RlF@^OA`d^{oCP(hOZnR ze0k`8^13db!+Aqz&T{aSG3ZE~Ll`{lV=jaBN12hZ>KvJl9@fZr8699`B?T6r!~cr^ zOh(0rGq@h3c(Mk*{xjkbqv5M}nG%@)E|VHRsjv1&L;U&YFye3{(hz{|jFC{004$@fQ&14m+WX zsMu}r_60H?{mTcBV_(aEMlzuBIC_k;zrYX-M)lr9XL9lv=&#r=lEV0~Bli$AT|^w> zBxQ8GhaQyjBEe|GMXb*GC2_}#eI4$ia&D;ql8lbf=7-8&p#2|ziIm2Nkt56mrIjMi zkOqq{k@Co(-XCHVULq+kA3}x#CSN9}@xknWL;1qX_z~9sjm*jHH%t*E2zp$8fphr; zNgM^={SB4NFTi>Q)k(Bs8-Opuy;o3bH9UF+b>)8e0)}nWj=?xBCLW2zz^`i z-w`^Lp)x~v7PaAXc$--oEzP?5AjkPJiNUcOKKVO&gsg$8Z&ATUTfGDDOxW=)RzfpM z!%YTowc`RJW~RA>N8vMMlWFjGtc1J@#(!X4(f(KfBcQC$>j=19zJt*84^+>(=(?Pk zAH@d{di1)w;5e2>T}~)IN}-KNi_y+CI4HZ{phMr=;q*&Rw8XuRV0SONnj4L-2GE#u zv3?it3^=Gy$AkHO#PnwWjU>lU>6;pXkah6oUlEx|`i=x}W$}jYUGy)xsW(Tud%Z#%%-3-FLcE+#gD-q#2S@I^){ts&;X%OX4oE zRn&_Yor|5Low2A)=LiKJy{Nip*lerGnzj?t-%!_Y^#q5m&HN ze~(_N|6I3GSF20Z9n~(;j@N#qsn%Rp&rw^{@2NUeIjY0Tc}iA!CVy4_#QeDY-FdZn z>bwtgm*ke`Ue4K?GaVIJcXoBQn9XFropr~mtYDUy_0Mb==-)07-YO8+w!)vhO}?xhvfg>Z2?ic z0=oVywgp7(3h4T;*cK4AE8wnwV_Ses_8;9Cu;U5!a54eD%0OIxQ3jJk4#IH(Vc1g{ zOco}b^j-^@Ob&dViOb8QnM@{X#i^N0G1#-1L6LB2C^#}G6ddUff~3I8h3HW4`T&8* zv-ApM8wp_gDS~O3ArmvLFlx{R{!@%66e+m-6vFBoA16K3?LrXYMFSnmV3ef-)os@@L$jH{mB0y z#L;t>qcTP8KPkZ#21x#QL4d(bFdF=C&@;KP{O5=PBjT?{mk+W1JD{TgyN6JI0yGw2 z-wzcq!Ve?)gPYrG1A*q|hGwB3vLD8@_T%+KNC1`^nTe5=zZbF}NojGo6w|qvVzlx# z&Srifa?fDY>KzjrFezD#p7g`^i4k*ZFE~v2R-& zeRH6xt*SZT_lIq~SKu={V}ZXNV6==qg!3mi2ZGIkmde(Knm|4AL+(MW>1Q^k2}f3Da5(#DTFci~}TLM5~NmKYW>JW9K4L+Rz^qh#`$I>rG_t zW0{ep6dImF^NfZF$epm3L;73?Q-Cj+1_)vhO{)a^A*5!1ON3-js`ph72oi`1&Ee(z z1^Or)Bpt$_*%*PzgVTS-PowG(Qx-`P>5m@_k7xTnwe7Iu5C$~M!1ETu<%qrwhDL$O zWLo=U2!kS4XH@uLggsbQU)54+Xs>FmEHuvStL{0fweCgG;nlT-jjL>JZEP_ZM?r~* zZyB*W118agV++GE|84#{v>$17fx$foUyAskx4(_CmH8shW6{M}6o|S9L-B&7rpBg* zu1nB)6gb|NWIDxTVA4RC+;cf}LfO&&M;k&n)I3^GsSEz`JE8y#R zSmT5M_YlRrbz<5M_LTk9YPlswMD`eslTEaU8|!SDkOhQR9e z*jOZdk=oMI7HFoSiK4#oUqd$u@zA{kV=Fv3iWw^gHijlNgyWY_gS ziw>NrMEx) zm{gy(n4g(3QCk?#*|sTOP+qpp9Mr61MzMiAHX^6wVp>l63$B&6S~HB= z&*+nS(BlcuxX_}7bFz2Qidv+uTbTN{X9Wbm*CToZq98eF{Hse(ks-McWrkvGxu_%|1Tv7}eYk5y1l@H$1G z1>@dg(vqlqeVq#LSK2IG7O^GN%-Kma;1~XELrNHa^){2M_!ZKx)3HNg`8$lcSC7Jk zchF4g*PFv2tq@tLD2HQkws*TC>cIFubqDUlOl}g5@cn>Ri@#Bm4Mmk0(Ni$|2JK3+-+Hg13Ky`4#jem3^PLjQ^XkR#g=Y^aqr^l z+6yXWyvt}6k79v-{3wg`V?=q1N08T#4yE@2L(qAQNm+RT&EOuqz}>&ck1_WuD0p%m z3X}mE6x->Ae-0l<6YPg!pBe9Azq_#bK-A|40G|}h01sn4h9nArgmJSdh$kA?!9^s3 z91M?O6JDN`93GG06P(j~(U7cZSXG!k0Qn)X4Rg8%ATj|*P;_91KFj&sMexb{%m{`h zunto~FoI9PhD?1_Z2?S!$7FBLEqDVuC_#1--6*H&TN-XUKR@97+y(ki5bha}K=rTn zd=j9CxV#Q6K1n2To+4LxCI%6ij{n6_v)WpKZ1GUNvwkvur@BoT%T za6SHg*+f-;Vur(J2a|pi>yDBAu+sZ~4(o2e33C5;1i9haYs?em5h(c{7p7mKb_p+Y zJ|BylSuv-B^YhO@9cA}Kv%QkwV|ktxT>MU0OW6fc%bL&Qc4AhX!+~i57vaeFjJ<0F zvJ-pN7yXZseM2tfpDR07wyUhWthQ`=S#g=REV1mH(vzhJ@SL6%xC6moIy3%VuMH;* zdkq^6OAO718F;FX){ua)0ijEISovYWo`MYpiwo)tRw<_!6c#A)XrBxE_w>8;>+}ot z)p)#*sNbf_(KGsUx}&@iIQ&IQ|`eKA#Rf9-hi+2aclH`dY;R$sV&V7ox#2MMMSzb@~Hu|~FU2p+w&f0Y&pRe+@chtQEc`A8E=1UQN zqD=B*j=b9ubO!}tC)|!~=0(g$G0W2wUYASS4wrQDv{75)*-!WPy8p4}cC>eNu3V|cr=r=4k%4sMc?4V_AmV;m`hp~Zd&kqUkz5D-HYUG(@J^r5tHjO+V9UdSW`7rQmZYRF} zrSzS`0L40aCQQ}J)8Z;Co9o(}KEjkA+%=zd<_C&|P7Q$#I{CQRMv)cgJ{)=jq4Oi? zbtbb*24Csq!v=ZVYeeo~=q5IF0uGew@ev<_8G7vH%dnK*9fKadd^o(Sm*-&~Jzl55 zMLj++2ZjQadKK=WKl@=>fxIG%`GM!~RCP4ZX@MsUSW;(@D{;fXX}peYZ>{3mcf)Lh z+`&vE@R&KhwhPnQR zXZmjZY-?rRy3h@5H{%oN;TZi;dJmg|sTO(KAdcm{t-*3QZZs~YmsLv>1iJ~2sk`qn{No^gwB*o={r*@d@R!)Fw!b_g4QZei)@7qohB7S zvthwyl}|uVf51UfgW;G}ekau0@U^+3kB!Q*%V$Kk(_VLCR8oR$JobY2a58Pv0bA|z z90Z-i$3>+=7Avp78FrMF->?{YOS+;@gDaQ>~B7PI?{U<>Ujl8PT-p-`i109VR8EUDj=fXIA=qM;f?|xRubID6E zHnt9b7?~43amkB@gpP&^qhY-VLgA(jNxlNlG}$4^?U-=%nIxY@uE9vRd_?Ak-d9J* z02h`42beV>n|uxryRpm_c!mB<>OJ%flbT7Pd~D|W=%NBmB^7**AkQBGPazilCCn|9 z-w#SWJ1d4J4fmc_g(yx_5i%|CaFKj0rkETr!g>z?q34fSA+s2XpM*~%nOiK+j)aN& z&#_X)=hOb;jFWoz)W){ZgW>S>f?~Oa?1C?7Ra-z&BDZJKy>?;Cc)%G%FbUb1@A&}z z$%N-ha72CrNu@X<4`E*;WkeUAbAgrs?#fd_Nhu1Sf;yDK0MSoNv9Fup2>xXMCb}I~ z#2gogA5TLFcH(2#l*v8#Jsc^MkLX$(B{$&M7o;cQU+5nr%OQ_t94cE|dC{ z()G`zu>1=%Si1h16qbKs21}goW(rIH!In2uSZ=1U+)QElk086@&8Yo=?#&byx`f5Z z`lE|CQ&?`Mu=H+?y_v$&yJz>meG1F#k;wC*F8TbMxhwxkxhpsKs@&YGa&xZ=wH|OE V$^SolRrbp1UX_ UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","title":"func blocked(Bool) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)","title":"func email(String, verified: Bool?, verify: Bool?, connection: String, clientId: String) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","title":"func emailVerified(Bool, connection: String) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)","title":"func password(String, verify: Bool?, connection: String) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)","title":"func phoneNumber(String, verified: Bool?, verify: Bool?, connection: String, clientId: String) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","title":"func phoneVerified(Bool, connection: String) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","title":"func userMetadata([String : Any]) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","title":"func username(String, connection: String) -> UserPatchAttributes","type":"method"}],"path":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","type":"class"},{"title":"Protocols","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)","title":"init(info: [String : Any], statusCode: Int)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/auth0apierror\/code","title":"var code: String","type":"property"},{"path":"\/documentation\/auth0\/auth0apierror\/info","title":"var info: [String : Any]","type":"property"},{"path":"\/documentation\/auth0\/auth0apierror\/statuscode","title":"var statusCode: Int","type":"property"}],"path":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"children":[{"children":[{"path":"\/documentation\/auth0\/auth0error\/cause-9wuyi","title":"var cause: Error?","type":"property"}],"title":"Auth0Error Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/auth0error\/cause-1atql","title":"var cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/auth0error\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/auth0error\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/auth0error","title":"Auth0Error","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authentication\/clientid","title":"var clientId: String","type":"property"},{"path":"\/documentation\/auth0\/authentication\/url","title":"var url: URL","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)","title":"func codeExchange(withCode: String, codeVerifier: String, redirectURI: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/jwks()","title":"func jwks() -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m","title":"func login(appleAuthorizationCode: String, fullName: PersonNameComponents?, profile: [String : Any]?, audience: String?, scope: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","title":"func login(appleAuthorizationCode: String, fullName: PersonNameComponents?, profile: [String : Any]?, audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b","title":"func login(email: String, code: String, audience: String?, scope: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","title":"func login(email: String, code: String, audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj","title":"func login(facebookSessionAccessToken: String, profile: [String : Any], audience: String?, scope: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g","title":"func login(facebookSessionAccessToken: String, profile: [String : Any], audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii","title":"func login(phoneNumber: String, code: String, audience: String?, scope: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","title":"func login(phoneNumber: String, code: String, audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq","title":"func login(usernameOrEmail: String, password: String, realmOrConnection: String, audience: String?, scope: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w","title":"func login(usernameOrEmail: String, password: String, realmOrConnection: String, audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg","title":"func login(withOOBCode: String, mfaToken: String, bindingCode: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","title":"func login(withOOBCode: String, mfaToken: String, bindingCode: String?) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","title":"func login(withOTP: String, mfaToken: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","title":"func login(withRecoveryCode: String, mfaToken: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","title":"func loginDefaultDirectory(withUsername: String, password: String, audience: String?, scope: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","title":"func loginDefaultDirectory(withUsername: String, password: String, audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct","title":"func multifactorChallenge(mfaToken: String, types: [String]?, authenticatorId: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","title":"func multifactorChallenge(mfaToken: String, types: [String]?, authenticatorId: String?) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb","title":"func renew(withRefreshToken: String, scope: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","title":"func renew(withRefreshToken: String, scope: String?) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)","title":"func resetPassword(email: String, connection: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)","title":"func revoke(refreshToken: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l","title":"func signup(email: String, username: String?, password: String, connection: String, userMetadata: [String : Any]?, rootAttributes: [String : Any]?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","title":"func signup(email: String, username: String?, password: String, connection: String, userMetadata: [String : Any]?, rootAttributes: [String : Any]?) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p","title":"func startPasswordless(email: String, type: PasswordlessType, connection: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe","title":"func startPasswordless(email: String, type: PasswordlessType, connection: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm","title":"func startPasswordless(phoneNumber: String, type: PasswordlessType, connection: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt","title":"func startPasswordless(phoneNumber: String, type: PasswordlessType, connection: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)","title":"func userInfo(withAccessToken: String) -> Request","type":"method"}],"path":"\/documentation\/auth0\/authentication","title":"Authentication","type":"protocol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)","title":"func deleteEntry(forKey: String) -> Bool","type":"method"},{"path":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","title":"func getEntry(forKey: String) -> Data?","type":"method"},{"path":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)","title":"func setEntry(Data, forKey: String) -> Bool","type":"method"}],"path":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/loggable\/logger","title":"var logger: Logger?","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/loggable\/logging(enabled:)","title":"func logging(enabled: Bool) -> Self","type":"method"},{"path":"\/documentation\/auth0\/loggable\/using(logger:)","title":"func using(logger: Logger) -> Self","type":"method"}],"path":"\/documentation\/auth0\/loggable","title":"Loggable","type":"protocol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/logger\/trace(request:session:)","title":"func trace(request: URLRequest, session: URLSession)","type":"method"},{"path":"\/documentation\/auth0\/logger\/trace(response:data:)","title":"func trace(response: URLResponse, data: Data?)","type":"method"},{"path":"\/documentation\/auth0\/logger\/trace(url:source:)","title":"func trace(url: URL, source: String?)","type":"method"}],"path":"\/documentation\/auth0\/logger","title":"Logger","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/trackable\/telemetry","title":"var telemetry: Telemetry","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/trackable\/tracking(enabled:)","title":"func tracking(enabled: Bool)","type":"method"},{"path":"\/documentation\/auth0\/trackable\/using(inlibrary:version:)","title":"func using(inLibrary: String, version: String)","type":"method"}],"path":"\/documentation\/auth0\/trackable","title":"Trackable","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/users\/token","title":"var token: String","type":"property"},{"path":"\/documentation\/auth0\/users\/url","title":"var url: URL","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"children":[{"children":[{"path":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln","title":"func get(String, fields: [String], include: Bool) -> Request","type":"method"}],"title":"Users Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","title":"func get(String, fields: [String], include: Bool) -> Request","type":"method"},{"path":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)","title":"func link(String, withOtherUserToken: String) -> Request<[ManagementObject], ManagementError>","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","title":"func link(String, withUser: String, provider: String, connectionId: String?) -> Request<[ManagementObject], ManagementError>","type":"method"}],"title":"Users Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","title":"func link(String, withUser: String, provider: String, connectionId: String?) -> Request<[ManagementObject], ManagementError>","type":"method"},{"path":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"func patch(String, attributes: UserPatchAttributes) -> Request","type":"method"},{"path":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","title":"func patch(String, userMetadata: [String : Any]) -> Request","type":"method"},{"path":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","title":"func unlink(identityId: String, provider: String, fromUserId: String) -> Request<[ManagementObject], ManagementError>","type":"method"}],"path":"\/documentation\/auth0\/users","title":"Users","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauth\/clientid","title":"var clientId: String","type":"property"},{"path":"\/documentation\/auth0\/webauth\/telemetry","title":"var telemetry: Telemetry","type":"property"},{"path":"\/documentation\/auth0\/webauth\/url","title":"var url: URL","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauth\/audience(_:)","title":"func audience(String) -> Self","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","title":"func clearSession(federated: Bool) -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","title":"func clearSession(federated: Bool) async throws","type":"method"}],"title":"WebAuth Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","title":"func clearSession(federated: Bool) -> AnyPublisher","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","title":"func clearSession(federated: Bool) async throws","type":"method"},{"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","title":"func clearSession(federated: Bool) -> AnyPublisher","type":"method"}],"title":"WebAuth Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","title":"func clearSession(federated: Bool) async throws","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","title":"func clearSession(federated: Bool, callback: (WebAuthResult) -> Void)","type":"method"}],"title":"WebAuth Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3","title":"func clearSession(federated: Bool, callback: (WebAuthResult) -> Void)","type":"method"},{"path":"\/documentation\/auth0\/webauth\/connection(_:)","title":"func connection(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/connectionscope(_:)","title":"func connectionScope(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/invitationurl(_:)","title":"func invitationURL(URL) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/issuer(_:)","title":"func issuer(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/leeway(_:)","title":"func leeway(Int) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/maxage(_:)","title":"func maxAge(Int) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/nonce(_:)","title":"func nonce(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/onclose(_:)","title":"func onClose((() -> Void)?) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/organization(_:)","title":"func organization(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/parameters(_:)","title":"func parameters([String : String]) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/provider(_:)","title":"func provider(WebAuthProvider) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/redirecturl(_:)","title":"func redirectURL(URL) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/scope(_:)","title":"func scope(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/start()-98znq","title":"func start() async throws -> Credentials","type":"method"},{"path":"\/documentation\/auth0\/webauth\/start()-qpqo","title":"func start() -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/webauth\/start(_:)","title":"func start((WebAuthResult) -> Void)","type":"method"},{"path":"\/documentation\/auth0\/webauth\/state(_:)","title":"func state(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"func useEphemeralSession() -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/usehttps()","title":"func useHTTPS() -> Self","type":"method"}],"path":"\/documentation\/auth0\/webauth","title":"WebAuth","type":"protocol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","title":"func finish(with: WebAuthResult)","type":"method"},{"path":"\/documentation\/auth0\/webauthuseragent\/start()","title":"func start()","type":"method"}],"path":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","type":"protocol"},{"title":"Structures","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","title":"init(info: [String : Any], statusCode: Int)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationerror\/cause","title":"var cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/code","title":"var code: String","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/debugdescription","title":"var debugDescription: String","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/info","title":"let info: [String : Any]","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isaccessdenied","title":"var isAccessDenied: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials","title":"var isInvalidCredentials: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","title":"var isInvalidRefreshToken: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isloginrequired","title":"var isLoginRequired: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid","title":"var isMultifactorCodeInvalid: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","title":"var isMultifactorEnrollRequired: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","title":"var isMultifactorRequired: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid","title":"var isMultifactorTokenInvalid: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","title":"var isNetworkError: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused","title":"var isPasswordAlreadyUsed: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","title":"var isPasswordLeaked: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough","title":"var isPasswordNotStrongEnough: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted","title":"var isRefreshTokenDeleted: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isruleerror","title":"var isRuleError: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","title":"var isTooManyAttempts: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isverificationrequired","title":"var isVerificationRequired: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/statuscode","title":"let statusCode: Int","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationerror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/authenticationerror\/==(_:_:)","title":"static func == (AuthenticationError, AuthenticationError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationerror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/authenticationerror","title":"AuthenticationError","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/challenge\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/challenge\/bindingmethod","title":"let bindingMethod: String?","type":"property"},{"path":"\/documentation\/auth0\/challenge\/challengetype","title":"let challengeType: String","type":"property"},{"path":"\/documentation\/auth0\/challenge\/oobcode","title":"let oobCode: String?","type":"property"}],"path":"\/documentation\/auth0\/challenge","title":"Challenge","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)","title":"init(authentication: Authentication, storeKey: String, storage: CredentialsStorage)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanager\/user","title":"var user: UserInfo?","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanager\/canrenew()","title":"func canRenew() -> Bool","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/clear()","title":"func clear() -> Bool","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","title":"func credentials(withScope: String?, minTTL: Int, parameters: [String : Any], headers: [String : String]) async throws -> Credentials","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm","title":"func credentials(withScope: String?, minTTL: Int, parameters: [String : Any], headers: [String : String]) -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","title":"func credentials(withScope: String?, minTTL: Int, parameters: [String : Any], headers: [String : String], callback: (CredentialsManagerResult) -> Void)","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)","title":"func enableBiometrics(withTitle: String, cancelTitle: String?, fallbackTitle: String?, evaluationPolicy: LAPolicy)","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","title":"func hasValid(minTTL: Int) -> Bool","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m","title":"func renew(parameters: [String : Any], headers: [String : String]) async throws -> Credentials","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20","title":"func renew(parameters: [String : Any], headers: [String : String]) -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","title":"func renew(parameters: [String : Any], headers: [String : String], callback: (CredentialsManagerResult) -> Void)","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai","title":"func revoke(headers: [String : String]) async throws","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","title":"func revoke(headers: [String : String]) -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","title":"func revoke(headers: [String : String], (CredentialsManagerResult) -> Void)","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","title":"func store(credentials: Credentials) -> Bool","type":"method"}],"path":"\/documentation\/auth0\/credentialsmanager","title":"CredentialsManager","type":"struct"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","title":"static func ~= (CredentialsManagerError, CredentialsManagerError) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","title":"static func ~= (CredentialsManagerError, Error) -> Bool","type":"op"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/cause","title":"let cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription","title":"var debugDescription: String","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","title":"static let biometricsFailed: CredentialsManagerError","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/largeminttl","title":"static let largeMinTTL: CredentialsManagerError","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","title":"static let noCredentials: CredentialsManagerError","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","title":"static let noRefreshToken: CredentialsManagerError","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/renewfailed","title":"static let renewFailed: CredentialsManagerError","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","title":"static let revokeFailed: CredentialsManagerError","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/storefailed","title":"static let storeFailed: CredentialsManagerError","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","title":"static func == (CredentialsManagerError, CredentialsManagerError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/jwk\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/jwk\/algorithm","title":"let algorithm: String?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/certchain","title":"let certChain: [String]?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/certthumbprint","title":"let certThumbprint: String?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/certurl","title":"let certUrl: String?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/exponent","title":"let exponent: String?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/keyid","title":"let keyId: String?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/keytype","title":"let keyType: String","type":"property"},{"path":"\/documentation\/auth0\/jwk\/modulus","title":"let modulus: String?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/usage","title":"let usage: String?","type":"property"}],"path":"\/documentation\/auth0\/jwk","title":"JWK","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/jwks\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/jwks\/keys","title":"let keys: [JWK]","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/jwks\/key(id:)","title":"func key(id: String) -> JWK?","type":"method"}],"path":"\/documentation\/auth0\/jwks","title":"JWKS","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)","title":"init(info: [String : Any], statusCode: Int)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/managementerror\/cause","title":"var cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/code","title":"var code: String","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/debugdescription","title":"var debugDescription: String","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/info","title":"let info: [String : Any]","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/statuscode","title":"let statusCode: Int","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/managementerror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/managementerror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/managementerror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/managementerror\/==(_:_:)","title":"static func == (ManagementError, ManagementError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/managementerror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/managementerror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/managementerror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/managementerror","title":"ManagementError","type":"struct"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/request\/headers(_:)","title":"func headers([String : String]) -> Request","type":"method"},{"path":"\/documentation\/auth0\/request\/parameters(_:)","title":"func parameters([String : Any]) -> Request","type":"method"},{"path":"\/documentation\/auth0\/request\/start()-132e1","title":"func start() -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/request\/start()-8gjgk","title":"func start() async throws -> T","type":"method"},{"path":"\/documentation\/auth0\/request\/start(_:)","title":"func start(Callback)","type":"method"},{"title":"Type Aliases","type":"groupMarker"},{"path":"\/documentation\/auth0\/request\/callback","title":"Request.Callback","type":"typealias"}],"path":"\/documentation\/auth0\/request","title":"Request","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/telemetry\/init()","title":"init()","type":"init"}],"path":"\/documentation\/auth0\/telemetry","title":"Telemetry","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/userinfo\/address","title":"let address: [String : String]?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/birthdate","title":"let birthdate: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/customclaims","title":"let customClaims: [String : Any]?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/email","title":"let email: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/emailverified","title":"let emailVerified: Bool?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/familyname","title":"let familyName: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/gender","title":"let gender: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/givenname","title":"let givenName: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/locale","title":"let locale: Locale?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/middlename","title":"let middleName: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/name","title":"let name: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/nickname","title":"let nickname: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/phonenumber","title":"let phoneNumber: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/phonenumberverified","title":"let phoneNumberVerified: Bool?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/picture","title":"let picture: URL?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/preferredusername","title":"let preferredUsername: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/profile","title":"let profile: URL?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/sub","title":"let sub: String","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/updatedat","title":"let updatedAt: Date?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/website","title":"let website: URL?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/zoneinfo","title":"let zoneinfo: TimeZone?","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/userinfo\/publicclaims","title":"static let publicClaims: [String]","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/userinfo\/init(json:)","title":"init?(json: [String : Any])","type":"init"}],"path":"\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations","title":"JSONObjectPayload Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/userinfo","title":"UserInfo","type":"struct"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","title":"static func ~= (WebAuthError, WebAuthError) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","title":"static func ~= (WebAuthError, Error) -> Bool","type":"op"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/cause","title":"let cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/debugdescription","title":"var debugDescription: String","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed","title":"static let idTokenValidationFailed: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/invalidinvitationurl","title":"static let invalidInvitationURL: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/noauthorizationcode","title":"static let noAuthorizationCode: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/nobundleidentifier","title":"static let noBundleIdentifier: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/other","title":"static let other: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/pkcenotallowed","title":"static let pkceNotAllowed: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/unknown","title":"static let unknown: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/usercancelled","title":"static let userCancelled: WebAuthError","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/webautherror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/webautherror\/==(_:_:)","title":"static func == (WebAuthError, WebAuthError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/webautherror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/webautherror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/webautherror","title":"WebAuthError","type":"struct"},{"children":[{"title":"Type Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauthentication\/cancel()","title":"static func cancel()","type":"method"},{"path":"\/documentation\/auth0\/webauthentication\/resume(with:)","title":"static func resume(with: URL) -> Bool","type":"method"},{"path":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)","title":"static func safariProvider(style: UIModalPresentationStyle) -> WebAuthProvider","type":"method"}],"path":"\/documentation\/auth0\/webauthentication","title":"WebAuthentication","type":"struct"},{"title":"Variables","type":"groupMarker"},{"path":"\/documentation\/auth0\/defaultscope","title":"let defaultScope: String","type":"var"},{"title":"Functions","type":"groupMarker"},{"path":"\/documentation\/auth0\/authentication(clientid:domain:session:)","title":"func authentication(clientId: String, domain: String, session: URLSession) -> Authentication","type":"func"},{"path":"\/documentation\/auth0\/authentication(session:bundle:)","title":"func authentication(session: URLSession, bundle: Bundle) -> Authentication","type":"func"},{"path":"\/documentation\/auth0\/users(token:domain:session:)","title":"func users(token: String, domain: String, session: URLSession) -> Users","type":"func"},{"path":"\/documentation\/auth0\/users(token:session:bundle:)","title":"func users(token: String, session: URLSession, bundle: Bundle) -> Users","type":"func"},{"path":"\/documentation\/auth0\/webauth(clientid:domain:session:)","title":"func webAuth(clientId: String, domain: String, session: URLSession) -> WebAuth","type":"func"},{"path":"\/documentation\/auth0\/webauth(session:bundle:)","title":"func webAuth(session: URLSession, bundle: Bundle) -> WebAuth","type":"func"},{"title":"Type Aliases","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationresult","title":"AuthenticationResult","type":"typealias"},{"path":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult","type":"typealias"},{"path":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","type":"typealias"},{"path":"\/documentation\/auth0\/managementobject","title":"ManagementObject","type":"typealias"},{"path":"\/documentation\/auth0\/managementresult","title":"ManagementResult","type":"typealias"},{"path":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","type":"typealias"},{"path":"\/documentation\/auth0\/webauthprovidercallback","title":"WebAuthProviderCallback","type":"typealias"},{"path":"\/documentation\/auth0\/webauthresult","title":"WebAuthResult","type":"typealias"},{"title":"Enumerations","type":"groupMarker"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/auth0\/passwordlesstype\/androidlink","title":"case androidLink","type":"case"},{"path":"\/documentation\/auth0\/passwordlesstype\/code","title":"case code","type":"case"},{"path":"\/documentation\/auth0\/passwordlesstype\/ioslink","title":"case iOSLink","type":"case"},{"path":"\/documentation\/auth0\/passwordlesstype\/weblink","title":"case webLink","type":"case"},{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)","title":"init?(rawValue: String)","type":"init"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/passwordlesstype\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passwordlesstype\/hashvalue","title":"var hashValue: Int","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","title":"func hash(into: inout Hasher)","type":"method"}],"path":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations","title":"RawRepresentable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passwordlesstype","title":"PasswordlessType","type":"enum"},{"title":"Extended Modules","type":"groupMarker"},{"children":[{"title":"Extended Structures","type":"groupMarker"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","title":"func a0_encodeBase64URLSafe() -> String?","type":"method"}],"path":"\/documentation\/auth0\/foundation\/data","title":"Data","type":"extension"}],"path":"\/documentation\/auth0\/foundation","title":"Foundation","type":"extension"},{"children":[{"title":"Extended Structures","type":"groupMarker"},{"children":[{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","title":"func deleteEntry(forKey: String) -> Bool","type":"method"},{"path":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","title":"func getEntry(forKey: String) -> Data?","type":"method"},{"path":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","title":"func setEntry(Data, forKey: String) -> Bool","type":"method"}],"path":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","title":"CredentialsStorage Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/simplekeychain\/simplekeychain","title":"SimpleKeychain","type":"extension"}],"path":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","type":"extension"},{"children":[{"title":"Extended Structures","type":"groupMarker"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","title":"func a0_decodeBase64URLSafe() -> Data?","type":"method"}],"path":"\/documentation\/auth0\/swift\/string","title":"String","type":"extension"}],"path":"\/documentation\/auth0\/swift","title":"Swift","type":"extension"}],"path":"\/documentation\/auth0","title":"Auth0","type":"module"}]},"schemaVersion":{"major":0,"minor":1,"patch":1}} \ No newline at end of file +{"interfaceLanguages":{"swift":[{"children":[{"title":"Articles","type":"groupMarker"},{"path":"\/documentation\/auth0\/refreshtokens","title":"Refresh Tokens: Common Errors","type":"article"},{"path":"\/documentation\/auth0\/useragents","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","type":"article"},{"title":"Classes","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)","title":"init(accessToken: String, tokenType: String, idToken: String, refreshToken: String?, expiresIn: Date, scope: String?, recoveryCode: String?)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentials\/accesstoken","title":"let accessToken: String","type":"property"},{"path":"\/documentation\/auth0\/credentials\/description","title":"var description: String","type":"property"},{"path":"\/documentation\/auth0\/credentials\/expiresin","title":"let expiresIn: Date","type":"property"},{"path":"\/documentation\/auth0\/credentials\/idtoken","title":"let idToken: String","type":"property"},{"path":"\/documentation\/auth0\/credentials\/recoverycode","title":"let recoveryCode: String?","type":"property"},{"path":"\/documentation\/auth0\/credentials\/refreshtoken","title":"let refreshToken: String?","type":"property"},{"path":"\/documentation\/auth0\/credentials\/scope","title":"let scope: String?","type":"property"},{"path":"\/documentation\/auth0\/credentials\/tokentype","title":"let tokenType: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentials\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/credentials\/decodable-implementations","title":"Decodable Implementations","type":"symbol"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentials\/init(coder:)","title":"init?(coder: NSCoder)","type":"init"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentials\/encode(with:)","title":"func encode(with: NSCoder)","type":"method"}],"path":"\/documentation\/auth0\/credentials\/nscoding-implementations","title":"NSCoding Implementations","type":"symbol"},{"children":[{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentials\/supportssecurecoding","title":"static var supportsSecureCoding: Bool","type":"property"}],"path":"\/documentation\/auth0\/credentials\/nssecurecoding-implementations","title":"NSSecureCoding Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/credentials","title":"Credentials","type":"class"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/userpatchattributes\/init(dictionary:)","title":"init(dictionary: [String : Any])","type":"init"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)","title":"func appMetadata([String : Any]) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","title":"func blocked(Bool) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)","title":"func email(String, verified: Bool?, verify: Bool?, connection: String, clientId: String) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","title":"func emailVerified(Bool, connection: String) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)","title":"func password(String, verify: Bool?, connection: String) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)","title":"func phoneNumber(String, verified: Bool?, verify: Bool?, connection: String, clientId: String) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","title":"func phoneVerified(Bool, connection: String) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","title":"func userMetadata([String : Any]) -> UserPatchAttributes","type":"method"},{"path":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","title":"func username(String, connection: String) -> UserPatchAttributes","type":"method"}],"path":"\/documentation\/auth0\/userpatchattributes","title":"UserPatchAttributes","type":"class"},{"title":"Protocols","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)","title":"init(info: [String : Any], statusCode: Int)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/auth0apierror\/code","title":"var code: String","type":"property"},{"path":"\/documentation\/auth0\/auth0apierror\/info","title":"var info: [String : Any]","type":"property"},{"path":"\/documentation\/auth0\/auth0apierror\/statuscode","title":"var statusCode: Int","type":"property"}],"path":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"children":[{"children":[{"path":"\/documentation\/auth0\/auth0error\/cause-9wuyi","title":"var cause: Error?","type":"property"}],"title":"Auth0Error Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/auth0error\/cause-1atql","title":"var cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/auth0error\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/auth0error\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/auth0error","title":"Auth0Error","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authentication\/clientid","title":"var clientId: String","type":"property"},{"path":"\/documentation\/auth0\/authentication\/url","title":"var url: URL","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)","title":"func codeExchange(withCode: String, codeVerifier: String, redirectURI: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/jwks()","title":"func jwks() -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m","title":"func login(appleAuthorizationCode: String, fullName: PersonNameComponents?, profile: [String : Any]?, audience: String?, scope: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-7k4xo","title":"func login(appleAuthorizationCode: String, fullName: PersonNameComponents?, profile: [String : Any]?, audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b","title":"func login(email: String, code: String, audience: String?, scope: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-587bo","title":"func login(email: String, code: String, audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj","title":"func login(facebookSessionAccessToken: String, profile: [String : Any], audience: String?, scope: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-8wh5g","title":"func login(facebookSessionAccessToken: String, profile: [String : Any], audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii","title":"func login(phoneNumber: String, code: String, audience: String?, scope: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-38nv0","title":"func login(phoneNumber: String, code: String, audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq","title":"func login(usernameOrEmail: String, password: String, realmOrConnection: String, audience: String?, scope: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-5yc0w","title":"func login(usernameOrEmail: String, password: String, realmOrConnection: String, audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg","title":"func login(withOOBCode: String, mfaToken: String, bindingCode: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3r1t9","title":"func login(withOOBCode: String, mfaToken: String, bindingCode: String?) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","title":"func login(withOTP: String, mfaToken: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","title":"func login(withRecoveryCode: String, mfaToken: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","title":"func loginDefaultDirectory(withUsername: String, password: String, audience: String?, scope: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-3uzbn","title":"func loginDefaultDirectory(withUsername: String, password: String, audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct","title":"func multifactorChallenge(mfaToken: String, types: [String]?, authenticatorId: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-3p692","title":"func multifactorChallenge(mfaToken: String, types: [String]?, authenticatorId: String?) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-8vkbb","title":"func renew(withRefreshToken: String, scope: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:scope:)-2llyg","title":"func renew(withRefreshToken: String, scope: String?) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)","title":"func resetPassword(email: String, connection: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)","title":"func revoke(refreshToken: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l","title":"func signup(email: String, username: String?, password: String, connection: String, userMetadata: [String : Any]?, rootAttributes: [String : Any]?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-4rw4y","title":"func signup(email: String, username: String?, password: String, connection: String, userMetadata: [String : Any]?, rootAttributes: [String : Any]?) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p","title":"func startPasswordless(email: String, type: PasswordlessType, connection: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-56xbe","title":"func startPasswordless(email: String, type: PasswordlessType, connection: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm","title":"func startPasswordless(phoneNumber: String, type: PasswordlessType, connection: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-9unt","title":"func startPasswordless(phoneNumber: String, type: PasswordlessType, connection: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:)","title":"func userInfo(withAccessToken: String) -> Request","type":"method"}],"path":"\/documentation\/auth0\/authentication","title":"Authentication","type":"protocol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)","title":"func deleteEntry(forKey: String) -> Bool","type":"method"},{"path":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","title":"func getEntry(forKey: String) -> Data?","type":"method"},{"path":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)","title":"func setEntry(Data, forKey: String) -> Bool","type":"method"}],"path":"\/documentation\/auth0\/credentialsstorage","title":"CredentialsStorage","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/loggable\/logger","title":"var logger: Logger?","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/loggable\/logging(enabled:)","title":"func logging(enabled: Bool) -> Self","type":"method"},{"path":"\/documentation\/auth0\/loggable\/using(logger:)","title":"func using(logger: Logger) -> Self","type":"method"}],"path":"\/documentation\/auth0\/loggable","title":"Loggable","type":"protocol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/logger\/trace(request:session:)","title":"func trace(request: URLRequest, session: URLSession)","type":"method"},{"path":"\/documentation\/auth0\/logger\/trace(response:data:)","title":"func trace(response: URLResponse, data: Data?)","type":"method"},{"path":"\/documentation\/auth0\/logger\/trace(url:source:)","title":"func trace(url: URL, source: String?)","type":"method"}],"path":"\/documentation\/auth0\/logger","title":"Logger","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/trackable\/telemetry","title":"var telemetry: Telemetry","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/trackable\/tracking(enabled:)","title":"func tracking(enabled: Bool)","type":"method"},{"path":"\/documentation\/auth0\/trackable\/using(inlibrary:version:)","title":"func using(inLibrary: String, version: String)","type":"method"}],"path":"\/documentation\/auth0\/trackable","title":"Trackable","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/users\/token","title":"var token: String","type":"property"},{"path":"\/documentation\/auth0\/users\/url","title":"var url: URL","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"children":[{"children":[{"path":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln","title":"func get(String, fields: [String], include: Bool) -> Request","type":"method"}],"title":"Users Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/users\/get(_:fields:include:)-8mfww","title":"func get(String, fields: [String], include: Bool) -> Request","type":"method"},{"path":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)","title":"func link(String, withOtherUserToken: String) -> Request<[ManagementObject], ManagementError>","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","title":"func link(String, withUser: String, provider: String, connectionId: String?) -> Request<[ManagementObject], ManagementError>","type":"method"}],"title":"Users Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-5y4yy","title":"func link(String, withUser: String, provider: String, connectionId: String?) -> Request<[ManagementObject], ManagementError>","type":"method"},{"path":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"func patch(String, attributes: UserPatchAttributes) -> Request","type":"method"},{"path":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","title":"func patch(String, userMetadata: [String : Any]) -> Request","type":"method"},{"path":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","title":"func unlink(identityId: String, provider: String, fromUserId: String) -> Request<[ManagementObject], ManagementError>","type":"method"}],"path":"\/documentation\/auth0\/users","title":"Users","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauth\/clientid","title":"var clientId: String","type":"property"},{"path":"\/documentation\/auth0\/webauth\/telemetry","title":"var telemetry: Telemetry","type":"property"},{"path":"\/documentation\/auth0\/webauth\/url","title":"var url: URL","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauth\/audience(_:)","title":"func audience(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/authorizeurl(_:)","title":"func authorizeURL(URL) -> Self","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","title":"func clearSession(federated: Bool) async throws","type":"method"},{"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","title":"func clearSession(federated: Bool) -> AnyPublisher","type":"method"}],"title":"WebAuth Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","title":"func clearSession(federated: Bool) -> AnyPublisher","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","title":"func clearSession(federated: Bool) -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","title":"func clearSession(federated: Bool) async throws","type":"method"}],"title":"WebAuth Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","title":"func clearSession(federated: Bool) async throws","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","title":"func clearSession(federated: Bool, callback: (WebAuthResult) -> Void)","type":"method"}],"title":"WebAuth Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9xcu3","title":"func clearSession(federated: Bool, callback: (WebAuthResult) -> Void)","type":"method"},{"path":"\/documentation\/auth0\/webauth\/connection(_:)","title":"func connection(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/connectionscope(_:)","title":"func connectionScope(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/invitationurl(_:)","title":"func invitationURL(URL) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/issuer(_:)","title":"func issuer(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/leeway(_:)","title":"func leeway(Int) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/maxage(_:)","title":"func maxAge(Int) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/nonce(_:)","title":"func nonce(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/onclose(_:)","title":"func onClose((() -> Void)?) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/organization(_:)","title":"func organization(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/parameters(_:)","title":"func parameters([String : String]) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/provider(_:)","title":"func provider(WebAuthProvider) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/redirecturl(_:)","title":"func redirectURL(URL) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/scope(_:)","title":"func scope(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/start()-98znq","title":"func start() async throws -> Credentials","type":"method"},{"path":"\/documentation\/auth0\/webauth\/start()-qpqo","title":"func start() -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/webauth\/start(_:)","title":"func start((WebAuthResult) -> Void)","type":"method"},{"path":"\/documentation\/auth0\/webauth\/state(_:)","title":"func state(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"func useEphemeralSession() -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/usehttps()","title":"func useHTTPS() -> Self","type":"method"}],"path":"\/documentation\/auth0\/webauth","title":"WebAuth","type":"protocol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","title":"func finish(with: WebAuthResult)","type":"method"},{"path":"\/documentation\/auth0\/webauthuseragent\/start()","title":"func start()","type":"method"}],"path":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","type":"protocol"},{"title":"Structures","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","title":"init(info: [String : Any], statusCode: Int)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationerror\/cause","title":"var cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/code","title":"var code: String","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/debugdescription","title":"var debugDescription: String","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/info","title":"let info: [String : Any]","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isaccessdenied","title":"var isAccessDenied: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials","title":"var isInvalidCredentials: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","title":"var isInvalidRefreshToken: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isloginrequired","title":"var isLoginRequired: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid","title":"var isMultifactorCodeInvalid: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","title":"var isMultifactorEnrollRequired: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","title":"var isMultifactorRequired: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid","title":"var isMultifactorTokenInvalid: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","title":"var isNetworkError: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused","title":"var isPasswordAlreadyUsed: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","title":"var isPasswordLeaked: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough","title":"var isPasswordNotStrongEnough: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted","title":"var isRefreshTokenDeleted: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isruleerror","title":"var isRuleError: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","title":"var isTooManyAttempts: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isverificationrequired","title":"var isVerificationRequired: Bool","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/statuscode","title":"let statusCode: Int","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationerror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/authenticationerror\/==(_:_:)","title":"static func == (AuthenticationError, AuthenticationError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationerror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/authenticationerror","title":"AuthenticationError","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/challenge\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/challenge\/bindingmethod","title":"let bindingMethod: String?","type":"property"},{"path":"\/documentation\/auth0\/challenge\/challengetype","title":"let challengeType: String","type":"property"},{"path":"\/documentation\/auth0\/challenge\/oobcode","title":"let oobCode: String?","type":"property"}],"path":"\/documentation\/auth0\/challenge","title":"Challenge","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)","title":"init(authentication: Authentication, storeKey: String, storage: CredentialsStorage)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanager\/user","title":"var user: UserInfo?","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanager\/canrenew()","title":"func canRenew() -> Bool","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/clear()","title":"func clear() -> Bool","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","title":"func credentials(withScope: String?, minTTL: Int, parameters: [String : Any], headers: [String : String]) async throws -> Credentials","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm","title":"func credentials(withScope: String?, minTTL: Int, parameters: [String : Any], headers: [String : String]) -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","title":"func credentials(withScope: String?, minTTL: Int, parameters: [String : Any], headers: [String : String], callback: (CredentialsManagerResult) -> Void)","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)","title":"func enableBiometrics(withTitle: String, cancelTitle: String?, fallbackTitle: String?, evaluationPolicy: LAPolicy)","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","title":"func hasValid(minTTL: Int) -> Bool","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m","title":"func renew(parameters: [String : Any], headers: [String : String]) async throws -> Credentials","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20","title":"func renew(parameters: [String : Any], headers: [String : String]) -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","title":"func renew(parameters: [String : Any], headers: [String : String], callback: (CredentialsManagerResult) -> Void)","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai","title":"func revoke(headers: [String : String]) async throws","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","title":"func revoke(headers: [String : String]) -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","title":"func revoke(headers: [String : String], (CredentialsManagerResult) -> Void)","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","title":"func store(credentials: Credentials) -> Bool","type":"method"}],"path":"\/documentation\/auth0\/credentialsmanager","title":"CredentialsManager","type":"struct"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","title":"static func ~= (CredentialsManagerError, CredentialsManagerError) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","title":"static func ~= (CredentialsManagerError, Error) -> Bool","type":"op"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/cause","title":"let cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription","title":"var debugDescription: String","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","title":"static let biometricsFailed: CredentialsManagerError","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/largeminttl","title":"static let largeMinTTL: CredentialsManagerError","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","title":"static let noCredentials: CredentialsManagerError","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","title":"static let noRefreshToken: CredentialsManagerError","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/renewfailed","title":"static let renewFailed: CredentialsManagerError","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","title":"static let revokeFailed: CredentialsManagerError","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/storefailed","title":"static let storeFailed: CredentialsManagerError","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","title":"static func == (CredentialsManagerError, CredentialsManagerError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/credentialsmanagererror","title":"CredentialsManagerError","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/jwk\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/jwk\/algorithm","title":"let algorithm: String?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/certchain","title":"let certChain: [String]?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/certthumbprint","title":"let certThumbprint: String?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/certurl","title":"let certUrl: String?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/exponent","title":"let exponent: String?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/keyid","title":"let keyId: String?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/keytype","title":"let keyType: String","type":"property"},{"path":"\/documentation\/auth0\/jwk\/modulus","title":"let modulus: String?","type":"property"},{"path":"\/documentation\/auth0\/jwk\/usage","title":"let usage: String?","type":"property"}],"path":"\/documentation\/auth0\/jwk","title":"JWK","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/jwks\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/jwks\/keys","title":"let keys: [JWK]","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/jwks\/key(id:)","title":"func key(id: String) -> JWK?","type":"method"}],"path":"\/documentation\/auth0\/jwks","title":"JWKS","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)","title":"init(info: [String : Any], statusCode: Int)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/managementerror\/cause","title":"var cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/code","title":"var code: String","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/debugdescription","title":"var debugDescription: String","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/info","title":"let info: [String : Any]","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/statuscode","title":"let statusCode: Int","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/managementerror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/managementerror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/managementerror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/managementerror\/==(_:_:)","title":"static func == (ManagementError, ManagementError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/managementerror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/managementerror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/managementerror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/managementerror","title":"ManagementError","type":"struct"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/request\/headers(_:)","title":"func headers([String : String]) -> Request","type":"method"},{"path":"\/documentation\/auth0\/request\/parameters(_:)","title":"func parameters([String : Any]) -> Request","type":"method"},{"path":"\/documentation\/auth0\/request\/start()-132e1","title":"func start() -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/request\/start()-8gjgk","title":"func start() async throws -> T","type":"method"},{"path":"\/documentation\/auth0\/request\/start(_:)","title":"func start(Callback)","type":"method"},{"title":"Type Aliases","type":"groupMarker"},{"path":"\/documentation\/auth0\/request\/callback","title":"Request.Callback","type":"typealias"}],"path":"\/documentation\/auth0\/request","title":"Request","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/telemetry\/init()","title":"init()","type":"init"}],"path":"\/documentation\/auth0\/telemetry","title":"Telemetry","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/userinfo\/address","title":"let address: [String : String]?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/birthdate","title":"let birthdate: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/customclaims","title":"let customClaims: [String : Any]?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/email","title":"let email: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/emailverified","title":"let emailVerified: Bool?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/familyname","title":"let familyName: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/gender","title":"let gender: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/givenname","title":"let givenName: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/locale","title":"let locale: Locale?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/middlename","title":"let middleName: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/name","title":"let name: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/nickname","title":"let nickname: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/phonenumber","title":"let phoneNumber: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/phonenumberverified","title":"let phoneNumberVerified: Bool?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/picture","title":"let picture: URL?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/preferredusername","title":"let preferredUsername: String?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/profile","title":"let profile: URL?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/sub","title":"let sub: String","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/updatedat","title":"let updatedAt: Date?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/website","title":"let website: URL?","type":"property"},{"path":"\/documentation\/auth0\/userinfo\/zoneinfo","title":"let zoneinfo: TimeZone?","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/userinfo\/publicclaims","title":"static let publicClaims: [String]","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/userinfo\/init(json:)","title":"init?(json: [String : Any])","type":"init"}],"path":"\/documentation\/auth0\/userinfo\/jsonobjectpayload-implementations","title":"JSONObjectPayload Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/userinfo","title":"UserInfo","type":"struct"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","title":"static func ~= (WebAuthError, WebAuthError) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","title":"static func ~= (WebAuthError, Error) -> Bool","type":"op"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/cause","title":"let cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/debugdescription","title":"var debugDescription: String","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed","title":"static let idTokenValidationFailed: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/invalidinvitationurl","title":"static let invalidInvitationURL: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/noauthorizationcode","title":"static let noAuthorizationCode: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/nobundleidentifier","title":"static let noBundleIdentifier: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/other","title":"static let other: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/pkcenotallowed","title":"static let pkceNotAllowed: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/transactionactivealready","title":"static let transactionActiveAlready: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/unknown","title":"static let unknown: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/usercancelled","title":"static let userCancelled: WebAuthError","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/webautherror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/webautherror\/==(_:_:)","title":"static func == (WebAuthError, WebAuthError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/webautherror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/webautherror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/webautherror","title":"WebAuthError","type":"struct"},{"children":[{"title":"Type Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauthentication\/cancel()","title":"static func cancel()","type":"method"},{"path":"\/documentation\/auth0\/webauthentication\/resume(with:)","title":"static func resume(with: URL) -> Bool","type":"method"},{"path":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)","title":"static func safariProvider(style: UIModalPresentationStyle) -> WebAuthProvider","type":"method"}],"path":"\/documentation\/auth0\/webauthentication","title":"WebAuthentication","type":"struct"},{"title":"Variables","type":"groupMarker"},{"path":"\/documentation\/auth0\/defaultscope","title":"let defaultScope: String","type":"var"},{"title":"Functions","type":"groupMarker"},{"path":"\/documentation\/auth0\/authentication(clientid:domain:session:)","title":"func authentication(clientId: String, domain: String, session: URLSession) -> Authentication","type":"func"},{"path":"\/documentation\/auth0\/authentication(session:bundle:)","title":"func authentication(session: URLSession, bundle: Bundle) -> Authentication","type":"func"},{"path":"\/documentation\/auth0\/users(token:domain:session:)","title":"func users(token: String, domain: String, session: URLSession) -> Users","type":"func"},{"path":"\/documentation\/auth0\/users(token:session:bundle:)","title":"func users(token: String, session: URLSession, bundle: Bundle) -> Users","type":"func"},{"path":"\/documentation\/auth0\/webauth(clientid:domain:session:)","title":"func webAuth(clientId: String, domain: String, session: URLSession) -> WebAuth","type":"func"},{"path":"\/documentation\/auth0\/webauth(session:bundle:)","title":"func webAuth(session: URLSession, bundle: Bundle) -> WebAuth","type":"func"},{"title":"Type Aliases","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationresult","title":"AuthenticationResult","type":"typealias"},{"path":"\/documentation\/auth0\/credentialsmanagerresult","title":"CredentialsManagerResult","type":"typealias"},{"path":"\/documentation\/auth0\/databaseuser","title":"DatabaseUser","type":"typealias"},{"path":"\/documentation\/auth0\/managementobject","title":"ManagementObject","type":"typealias"},{"path":"\/documentation\/auth0\/managementresult","title":"ManagementResult","type":"typealias"},{"path":"\/documentation\/auth0\/webauthprovider","title":"WebAuthProvider","type":"typealias"},{"path":"\/documentation\/auth0\/webauthprovidercallback","title":"WebAuthProviderCallback","type":"typealias"},{"path":"\/documentation\/auth0\/webauthresult","title":"WebAuthResult","type":"typealias"},{"title":"Enumerations","type":"groupMarker"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/auth0\/passwordlesstype\/androidlink","title":"case androidLink","type":"case"},{"path":"\/documentation\/auth0\/passwordlesstype\/code","title":"case code","type":"case"},{"path":"\/documentation\/auth0\/passwordlesstype\/ioslink","title":"case iOSLink","type":"case"},{"path":"\/documentation\/auth0\/passwordlesstype\/weblink","title":"case webLink","type":"case"},{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)","title":"init?(rawValue: String)","type":"init"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/passwordlesstype\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passwordlesstype\/hashvalue","title":"var hashValue: Int","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","title":"func hash(into: inout Hasher)","type":"method"}],"path":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations","title":"RawRepresentable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passwordlesstype","title":"PasswordlessType","type":"enum"},{"title":"Extended Modules","type":"groupMarker"},{"children":[{"title":"Extended Structures","type":"groupMarker"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","title":"func a0_encodeBase64URLSafe() -> String?","type":"method"}],"path":"\/documentation\/auth0\/foundation\/data","title":"Data","type":"extension"}],"path":"\/documentation\/auth0\/foundation","title":"Foundation","type":"extension"},{"children":[{"title":"Extended Structures","type":"groupMarker"},{"children":[{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","title":"func deleteEntry(forKey: String) -> Bool","type":"method"},{"path":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","title":"func getEntry(forKey: String) -> Data?","type":"method"},{"path":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","title":"func setEntry(Data, forKey: String) -> Bool","type":"method"}],"path":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","title":"CredentialsStorage Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/simplekeychain\/simplekeychain","title":"SimpleKeychain","type":"extension"}],"path":"\/documentation\/auth0\/simplekeychain","title":"SimpleKeychain","type":"extension"},{"children":[{"title":"Extended Structures","type":"groupMarker"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","title":"func a0_decodeBase64URLSafe() -> Data?","type":"method"}],"path":"\/documentation\/auth0\/swift\/string","title":"String","type":"extension"}],"path":"\/documentation\/auth0\/swift","title":"Swift","type":"extension"}],"path":"\/documentation\/auth0","title":"Auth0","type":"module"}]},"schemaVersion":{"major":0,"minor":1,"patch":1}} \ No newline at end of file diff --git a/docs/index/navigator.index b/docs/index/navigator.index index d33f4489caed3a8528a39d15f47a1e1e4f600727..ccaa7bfb715c0686748979ad5a38b03a3802a975 100644 GIT binary patch delta 1067 zcmYjQYfM{Z80PK#*l|j98BJi}L=92*0~WjCHhw5#VvKTW*@i~CcAj-*Tu$3jdU|1l zO*D%!k!c_IW5hXXj3!8Ibc`onmYq~VQ z>hYhe`bw(Fhm_44cPnaf*7B#`@Oz%uj8H=$*x2T+-CntYzqsyr>FJDU1a-5h+VLK= zc3WO3sQFtpPpC2AFJ}yU%k`jF+Z#hq;uZCOW;zn~YRl$xJgXUr4XWAw-Qs!_4o2dG zg>)R+seC;9vx1)nYSGO~H~I&^rBT+8i&3tLqGnh{!D%;ZeV%;SRRv$4_EIwbITt>q zpzw?)k{k?U?MW*>oKo=pnO#!(N-70sJ829j&z@j>Z73$jIIF{!R53HOU9y8HAF`r9 zsi5-Q9{L--=T0zI4S&p-8vacD!xe|{(4wOKSFdDknOR3ha`D%6QG7TLyG9gg_DHj1 zq>COQXEedsJKD}zoQ#M^-0JYkI6tjJ@z^o3jR2l~-zjogi^!4l=UtSG z^6{9|K9#+v#>2wOi8vB3s?aY)CG&G%71WHY~#8J6e{Ut-PX1UnoOEpvl`(<5fMrNV8%T7@zXQW@aZrUwbYvzS#r#}!*_K(S) zwKE6EiPTJ!)Q-v{9B~D%-wcbB(6?iG@wea20nNT6TwLhOg!I`RJyZ`H5&AUTG4THl0s(9EhmwIUv4i^7>PUoQUr;+0~CdJ?>@!QbsvoOg&(PH z1zE8iAhg)cCu89)wqD-go6OZeEPf)=%9nDdw;mj#UT%>u@4WdSC_PAT|LY3c9>)Fy DX{eq$ delta 1071 zcmYk4T}+#06vulyA6j85A~lp)qA}_&<{XnjF_FzHH?~lw23t2k7=zN5j~3d#KxaoZ z;^H#g{$^%=1WBA`#_6AcjJtW4PC-47v{^y+M zoabHsWz}ETR-G)ViX5-nQbTSGudzfvIJQ_wZ(&_Dfb8gl!08}S|RFWe{F#M1Oi8CQlK75n3z!|es646+fun-cn7SxP3 zs=xp9&yR*gh2#p_*h=i>%s{v`)~ar@Gb}v^;(O>OQt^I1I}#tMC62r;J*~-ow1lsd zdxdqPmb=);YnXjDKA`eQr#mP<`$RY8VPc|BSfBK8O*W`|*b$T-smWSVKBVIoc&6;4 zUc&>uCS0Bh=<^AWMGIC|w;t68bKx8;!s)p}%E#jOewELaoYMc*=_*m0%xoWDjZ5Pz z86S@3DJ%P4;*KV4zT1ev*`}-vY1ZMYDIfPgW5lhq+tpS^ugk?<=e(l4vZUp6&x_Jz z0B0=oPQ`eC=3agyeI;S=y#nOs7_s!j3si|6=L4#eD}`lBmTJ9rfQk&mo;R5&E88LLXM*UQxi^Y zHX>&stm@h05>KZ1Ckxe7kL88^dM6?JNWGyv=+Ykh4c7MEE)SmiX-T!QVJ*^^O_49wo5)~wH+j76gvsLTSv_uNO9w@&OA5(Q z(&F=5J1OGbcpGJxX};avUQSF(yu+8*?k1(8a9OhHVg&DgcrOWOaw pIHGzu{c}mbu{cC0@Wzc}>IAbx!ffd